REST API

REST API란

REST를 기반으로 만들어진 API를 의미

REST란

REST (Representational State Transfer) 자원을 이름으로 구분하여 해당자원의 상태를 주고받는 모든 것을 의미

 

REST API 설계

1.동사보단 명사를, 단수보단 복수를

/member/get/item/hello  (X)

/members/items (O)

 

2.마지막에 / 넣지 않기

/members/ (x)

/members (o)

 

3. _대신 - 사용 + 대문자 사용하지 않기

/restful_services (x)

/restful-services (o)

 

4.확장자 포함하지 않기(svg,png,exe 등)

/image.svg (x)

/images (o)

 

5.계층화

/items/{memberId}/members/{itemId} (x)

/members/{memberId}/items/{itemId} (o)

- 예를 들어 해당 카테고리 뒤에 id가 온다면 그건 그 카테고리의 id임을 나타낸다. 경로에 따라 member/{(items)id}/items 가 정상 작동 하는 경우도 있으나 item 뒤에 id를 넣어주는게 맞다. 실제로 본인도 과제 진행하면서 순서에 따라 만들다보니 이런경우가 발생하였는데 다른분들이 해당 타이틀 뒤에 id 넣는거 보고 왜그런지 궁금해서 찾아보고 수정하였다.