[API] RESTful API 설계 시 유의해야할 점

1. URI는 Information의 Resource를 표현한다.

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

: Company의 user들의 정보 요청하는 경우

: URI  >>  /company/{:id} /users

 

2.Resource에 대한 행위 HTTP Method로 표현한다.

: company의 정보 조회

: GET /company/details/{:id}  >> X

: GET /company/{:id} >> O

 

2-1 HTTP Method 

GET : Collection에 속한 Element들의 USI나 목록을 출력

POST : 해당 Collection에 속하는 새로운 Element를 생성

PUT(:id) : 전체 Collection 을 수정

PATCH(:id) : 전체 Collection의 일부 속성을 수정

DELETE(:id) : 전체 Collection을 삭제

 

3. Method는 URL에 포함하지 않는다.

: POST /company/1/update-users/1  >> X

: POST /company/1/users/1 >> O

 

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

 

5. _대신 -를 사용한다.

: -의 사용도 최소화 하며 설계한다.

: -를 사용하는 경우는 정확한 의미 전달이나 표현을 위해 단어 결합이 불가피한 경우 사용한다.

 

6. 대문자 대신 소문자를 사용한다.

 

7. Control Resource의 경우 동사형태를 허용한다.

 

 

 

출철 : 

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