최근 우리 회사에서는 API 인터페이스에서 반환되는 JSON 데이터 형식을 디자인하는 데 널리 사용되는 모범 사례가 있나요?
현재 다음 버전을 찾았습니다
버전 1: 성공적으로 실행됨: 헤드 상태 코드:2XX
json {"id":51,"age":58,"name":"lifei"}
실패한 실행 헤드 상태 코드:4XX-5XX {"메시지":"xxxxxx 오류","오류:{}}
버전 2: 성공 및 실패 실행 헤드 상태 코드:2xx
json {"코드":"0","메시지:"정보","데이터":{}}
버전 3: 성공적으로 실행됨: 헤드 상태 코드:2XX
json {"id":51,"age":58,"name":"lifei"}
실패한 실행 헤드 상태 코드:4XX-5XX {"code":10001, "message":"xxxxxx error","errors:{}}
업무상 다양한 오류가 있을 경우 예를 들어 현금을 인출하려는 경우 은행카드 미장착, 통장 미업로드, 신분증 미업로드 등의 오류가 발생할 수 있습니다. , 휴대폰 번호가 바인딩되지 않음, 주소가 입력되지 않음, 잔액이 없음 등이 발생합니다.
이런 종류
http://swagger.io/
http://jsonapi.org/
https://github.com/interagent...
이런 사양은 비교적 복잡하지만 한 번 익히면 평생 사용할 수 있고 프론트엔드, 백엔드 모두 쉽게 재사용할 수 있습니다
사양을 직접 정의하면 간단하다는 장점이 있지만 설계 시 많은 세부 사항을 고려하지 않아 수정이 매우 번거로울 수 있습니다
https://github.com/ShuyunXIAN...
JSON RPC 2.0
http://www.jsonrpc.org/specif...