RESTFUL API 작성

[ REST API 설계 규칙 ]

 

- URI는 정보의 자원을 표현해야함 ( 리소스 명은 동사보다 명사를 사용)

- 자원에 대한 행위는 HTTP METHOD(GET, POST, PUT, DELETE )로 표현

- 관계명이 복잡하다면 이를 서브 리소스에 표현

      -> 예를 들어 사용자가 좋아하는 디바이스 목록을 표현해야할 경우 

GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)

- 컬렉션은 문서들의 집합, 객체들의 집합을 나타냄 (단/복수도 지켜준다면 좀 더 이해하기 쉬운 URI를 설계할 수 있음)

sports라는 컬렉션과 soccer이라는 도큐먼트로 표현하고 있음 

컬렉션은 sports로 복수로 나타내고 있음 

/sports/soccer/players/13

ex) GET /members/show/1     (x)

    GET /members/1          (o)

    GET /members/insert/2 (x)  - GET 메서드는 리소스 생성에 맞지 않음.

    POST /members/2       (o)

 

 

카카오 API 레퍼런스 

 

https://developers.kakao.com/docs/latest/ko/reference/rest-api-reference

Kakao Developers