[api] 빈 테이블에 대한 적절한 REST 응답?

나도 말하고 싶다.

404 (찾을 수 없음)가 아닌 이유는 무엇입니까?

404 상태 코드는 리소스를 찾을 수없는 상황을 위해 예약해야합니다. 이 경우 리소스는 사용자 모음입니다 . 이 컬렉션은 존재하지만 현재 비어 있습니다. 개인적으로 누군가가 몇 명의 사용자를 제거했기 때문에 200하루와 404다음 날 이 있으면 응용 프로그램의 클라이언트 작성자로서 매우 혼란 스러울 것 입니다. 나는 무엇을해야합니까? 내 URL이 잘못 되었나요? 누군가 API를 변경하고 리디렉션을 무시 했습니까?

204 (콘텐츠 없음)가 아닌 이유는 무엇입니까?

다음 은 w3c의 204 상태 코드 설명 에서 발췌 한 것입니다 .

서버가 요청을 수행했지만 엔티티 본문을 반환 할 필요가 없으며 업데이트 된 메타 정보를 반환 할 수 있습니다.

이 경우 합리적으로 보일 수 있지만 클라이언트를 혼란스럽게 할 수도 있습니다. A 204는 일부 작업이 성공적으로 실행되었으며 데이터를 반환 할 필요가 없음을 나타냅니다. 이는 DELETE요청에 대한 응답으로 완벽 하거나 데이터를 반환 할 필요가없는 일부 스크립트를 실행할 수 있습니다. 의 경우 api/users일반적으로 사용자 컬렉션의 대표를받을 것으로 예상합니다. 응답 본문을 한 번 보내고 다른 번에는 보내지 않는 것은 일관성이없고 잠재적으로 오해의 소지가 있습니다.

200을 사용하는 이유 (OK)

위에서 언급 한 이유 (일관성)로 인해 빈 컬렉션의 표현을 반환합니다. XML을 사용하고 있다고 가정 해 보겠습니다. 비어 있지 않은 사용자 컬렉션에 대한 일반적인 응답 본문은 다음과 같습니다.

<users>
  <user>
    <id>1</id>
    <name>Tom</name>
  </user>
  <user>
    <id>2</id>
    <name>IMB</name>
  </user>
</users>

목록이 비어 있으면 다음과 같이 응답 할 수 있습니다 (아직 사용하는 동안 200).

<users/>

어느 쪽이든 클라이언트는 잘 알려진 특정 형식을 따르는 응답 본문을받습니다. 불필요한 혼동 및 상태 코드 검사가 없습니다. 또한 상태 코드 정의를 위반하지 않습니다. 모두가 행복합니다.

JSON이나 HTML 또는 사용중인 모든 형식으로 동일한 작업을 수행 할 수 있습니다.

---

답변