RESTful API 자원 이름 지정에서 단수 명사에 대한 인수는 무엇입니까?


12

RESTful URI의 이름을 지정할 때 일반적으로 복수를 사용하여 리소스 모음을 나타내는 것이 허용됩니다. 대신 단수 명사를 사용한다는 주장이 궁금합니다.


아마도 모든 것이 컬렉션이 아니기 때문일까요?
jwenting

싱글 톤 리소스가 작동하는 곳이 아닙니까?
자선

답변:


12

일부 자원에는 단일 항목 만 포함됩니다. 좋은 예는 렌더링 할 데이터를 찾기 위해 ID가 필요하지 않은 모든 것입니다. 예를 들어 로그인 리소스가 매우 일반적입니다. 사용자 및 브라우저보기에서 단일 로그인 만 있습니다. 당신은 그것을 만들 수 있습니다, 당신은 그것을 파괴 할 수 있지만 선택할 수있는 여러 로그인과 인덱스 작업이 없습니다.

유사한 예는 회사 정보, 출판물, 연락처 양식 및 단일 항목 만 표시하거나 단일 작성 조치 만 허용하는 유사한 것들과 같은 대부분의 정적 페이지입니다.

단수 명사를 사용하면 코드의 가독성을 크게 향상시킬 수 있다면 토론의 문제가 될 수 있습니다.


5

때문에:

  1. "체리"와 같은 영어 복수 규칙은 특히 영어가 모국어가 아닌 경우 API를 개발하는 동안 생각하기에 가장 좋지 않습니다.
  2. 때로는 모델에서 엔드 포인트를 생성하려고 할 때가 일반적입니다. 위와 잘 어울리지 않습니다.
  3. "일반적으로 목록을 가져 오기 위해 쿼리를 시작합니다"라는 인수는 실제 사용 사례를 나타내지 않습니다. 그리고 당신은 단일 아이템뿐만 아니라 많은 아이템리스트를 쿼리하게됩니다.
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.