2013-04-15 2 views
0

요청/응답에 JSON을 사용하는 API를 작성 중입니다. 대량 요청 (예 : JSON 배열)을 수신 할 수 있기를 원합니다. 하나는 하나의 요청하고자하는 경우도API 작성 : JSON 1 요소 배열 용 배열?

[ 
{"id":"AAAEEF", "value":"abc"} 
] 

작품,

[ 
{"id":"AAAEEF", "value":"abc"}, 
{"id":"AAAEF1", "value":"vbc"}, 
] 

:

는 지금, 나는 JSON 요청이 항상 배열에 싸여 경우 잘 작동 해결책을 가지고 있습니다 id-value 조합 및 따라서 요청

{"id":"AAAEEF", "value":"abc"} 

요청이 실패합니다.

내 질문 : 요소가 하나만 있어도 배열에 모든 JSON 요청을 래핑하도록 "양호한"API를 적용 할 수 있습니까?

나를 도와 주셔서 미리 감사드립니다.

답변

0

"좋은"API를 작성하는 열쇠는 일관성 있고 잘 문서화하는 것입니다. 어떤 선택을하든 다음 단계로 넘어갈 수 있습니다. API에 대한 모든 호출에 thisIsAContainerObject 요소를 래핑해야한다는 정당한 이유가 있다고 판단되면 반드시 문서화하고 릴리스하십시오.

일관성을 위해 항상 배열이 필요한 경우가 더 낫습니다. 하나 이상의 요소가 삽입 될 때 적절한 오류가 발생하는 한.

+0

대단히 감사합니다. 그것은 모든 호출에서 '[]'을 요구하는 공식적인 문제가 없음을 의미합니까? – dp0377

+0

일관성은 항상 좋으며 API를 쉽게 구현할 수도 있습니다. 그것은 모두 당신 자신의 선택에 달려있다. –