[REST API] REST API 설계 방법

 

1. / 의 의미

: /는 계층 관계를 나타내는 데 사용한다.

/resource1/{:id}/resource2

 

ex)

GET /users/111/devices

: 111번 유저가 소유한 기기목록 정보 요청

 

or 

 

GET /users/111/likes/devices

: 111번 유저가 좋아하는 소유한 기기 목록 정보

 

 

Resource에 대한 행위는 HTTP Method로 표현함!

 

---

2. REST API 규칙

 

(1) Method는 URL에 포함하지 않는다.

 

(2) URL 마지막엔 /를 포함하지 않는다.

 

(3) 파일 확장자는 URI에 포함시키지 않는다.

 

(4) _대신 -를 사용한다. 

대신 -의 사용도 최소화해야함.

 

(5) 대문자 대신 소문자를 사용한다.

 

(6) Control Resource의 경우 동사형태를 허용한다. 

> HTTP Method로 표현되는 행위들 외에 다른 행위를 표현해야 하는 경우

 

 

 

(참고 자료)

https://velog.io/@gillog/RESTful-API-%EC%84%A4%EA%B3%84%EC%8B%9C-%EC%9C%A0%EC%9D%98-%EC%82%AC%ED%95%AD