질문: 비정상적인 API 데이터 구조

2715 단어 apiwebdev
안녕,

공개된 API에서 특이한 데이터 구조를 찾고 있습니다.
내가 만들고 있는 라이브러리의 사용 사례로 몇 가지 예를 찾고 있는 API 공급업체를 부끄럽게 하거나 비난하려는 것은 아닙니다.

예를 들어 유효성 검사 오류가 있을 때 이 API 구조를 만난 적이 있습니다.

{
  data: null,
  errors: {
    fieldName: [{
      description: "some friendly message",
      code: 000
    }],
    otherFieldName: [/* ... */]
  }
}


여기서 문제는 필드 이름이 배열이 아니며 필드 이름을 미리 알지 못한다는 것입니다.
우리의 경우 C#에 매핑했기 때문에 List<FieldValidationError> 에 매핑하는 사용자 지정 변환기를 작성했습니다.

public sealed class FieldValidationError {
  public string FieldName { get; set; }
  public string Description { get; set; }
  public int ErrorCode { get; set; }
}


그리고 이것은 오류 로깅을 훨씬 더 간단하게 만들었습니다.

슬프게도 이것이 어떤 API인지 기억나지 않으며 어쨌든 폐쇄형 시스템이었던 것 같습니다.


간단히 말해서 내가 찾고있는 것 :
  • 일반에 공개된 문서 링크
  • 비정상적인 이유에 대한 간단한 설명
    아마도 JSON/XML에서 코드의 최종 모델까지의 예를 사용하여 코드의 모양이나 매핑을 원할 것입니다(모든 언어 가능).
  • 좋은 웹페이지 즐겨찾기