[웹 API 디자인] 9. 여러 가지 형식 지원

여러 가지 형식 지원

우리는 한 가지 형식으로만 제공하는 것이 아니라 여러 가지 형식을 지원하는 것이 좋다고 추천합니다. 한 형식으로 데이터를 내보내고 필요한 만큼 많은 형식을 허용하는 것이 좋습니다. 일반적으로 형식에서 형식으로 자동 매핑할 수 있습니다.

다음은 몇 가지 주요 API의 구문입니다.

Google Data

?alt=json

Foursquare

/venue.json

Digg*

Accept: application/json
?type=json

* type 인수가 있는 경우 Accept 헤더를 재정의합니다.

Digg는 순수한 RESTful 방식인 Accept 헤더나 URL의 type 매개변수 두 가지 방법으로 지정할 수 있습니다. 이는 혼란스러울 수 있습니다. 최소한 충돌이 있을 때 무엇을 해야 하는지 문서화해야 합니다.

Foursquare의 방식을 권장합니다.

JSON 형식의 컬렉션 또는 특정 요소를 얻으려면:

dogs.json
/dogs/1234.json

파일 시스템을 사용하는 개발자나 일반 사용자는 이 점 표기법에 익숙합니다. 또한, 메시지 전달에 필요한 문자(점 하나)가 추가됩니다.

기본 포맷에 대해서 어떻게 생각하시나요?

제 의견으로는 JSON이 기본 포맷으로 이기고 있다고 생각합니다. JSON은 우리가 가지고 있는 유니버설 언어와 가장 유사합니다. 백엔드가 Ruby on Rails, PHP, Java, Python 등으로 구축되었더라도 대부분의 프로젝트는 프론트엔드에 JavaScript를 사용하기 때문에 이점이 있습니다. 또한 XML보다 덜 길게 작성되는 장점이 있습니다.