개요

application/vnd.api+json은 JSON:API 명세를 따르는 응답의 미디어 타입입니다. 리소스 표현·관계·페이지네이션·에러 형식을 표준화해, API 설계마다 제각각인 JSON 구조를 규격화합니다.

자세히

JSON:API는 최상위에 data·errors·meta·included 등의 예약 멤버를 두고, 각 리소스를 type·id·attributes·relationships·links로 표현합니다. `vnd.`는 벤더 트리(vendor tree) 등록을 뜻하고 `+json` 접미사로 JSON 위에 세워졌음을 나타냅니다. 관계 링크와 included를 통해 연관 리소스를 한 응답에 함께 실어 N+1 요청을 줄입니다.

규격은 미디어 타입 협상에 엄격합니다. 클라이언트는 반드시 `Accept: application/vnd.api+json`을, 요청 본문에는 동일한 Content-Type을 보내야 하며, 서버는 미디어 타입에 파라미터가 붙으면 415(Unsupported Media Type) 또는 406(Not Acceptable)으로 응답하도록 규정합니다. sparse fieldset(`fields[type]=...`)과 include 쿼리로 응답을 세밀히 제어합니다.

문법

e.g. Content-Type: application/vnd.api+json

실무 참고

• 미디어 타입에 파라미터(charset 등)를 붙이면 규격상 거부될 수 있습니다 — 순수하게 application/vnd.api+json만 보내세요.
• 에러는 최상위 errors 배열로 반환하며, 필요하면 application/problem+json 대신 이 스키마의 에러 객체를 씁니다.
• included에 과도하게 리소스를 실으면 응답이 비대해지므로 include와 sparse fieldset을 신중히 조합하세요.

관련 타입

관련 헤더