[Utils] API 설계 백그라운드

RESTful API 설계 가이드

https://sanghaklee.tistory.com/57

 

자주 사용하는 http status code

https://gist.github.com/subicura/8329759

 

200번대

200 OK

request 성공

ex) resource 목록/resource 상세/resource 수정/그외 대부분의 API 성공

성공 메시지가 날아오는 경우는 200이라고 생각해도 무방

 

201 Created

request 성공

ex) resource 생성 성공

 

204 No Content

request 성공

ex) resource 삭제 성공

 

 

300번대

301 move permanently

페이지 이동

 

307 temporary_redirect

임시 페이지 이동

 

 

400번대 

400 Bad Request

request 실패 (요구사항 위반)

ex) 유효성 검사 통과 실패, 잘못된 요청

에러 이유를 반드시 알림

 

401 Unauthorized

인증 실패

ex) 세션 없음, 로그인 실패

 

403 Forbidden

인증은 성공했으나 권한이 없음

ex) 권한없는 자원에 접근하려함

 

404 Not Found

API 없음

ex) route 조회 실패

 

405 Method Not Allowed

method를 제공하지 않을 때

ex) POST /users/1에 해당하는 API가 없는 경우 405로 응답

 

409 Conflict

요청의 모순이 생긴 경우, 중복되는 경우

ex) 이미 존재하는 ID로 회원가입

 

500번대

500 internal server error

오류

ex) 서버오류, exception

 

 

 

Resource의 식별 - Path variable

https://ryan-han.com/post/translated/pathvariable_queryparam/

Resource의 정렬/필터링 - Query Parameter.

/users // 사용자 목록을 가져온다.
/users?occupation=programer // 프로그래머인 사용자 목록을 가져온다.
/users/123 // 아이디가 123인 사용자를 가져온다.