Restful API 개발 참고 사항 요약

Restful API 개발 참고 사항 요약

1. URI 구성

- URI를 통해 특정 리소스를 명확하게 표현한다. 컬렉션은 복수형, 도큐먼트는 단수형을 사용

/members/1/bookmarks

/products/321/comments/2

- 행위는 HTTP method를 이용한다. URI에 행위를 표현하는 동사형 단어가 사용되어서는 안된다.

POST : insert

PUT : update

GET : read

DELETE : delete

- 소문자만 사용하며, 가독성을 위해서 '-' (하이픈)을 사용할 수 있다.

2. HTTP Header 사용하여 응답 형태 구성

- Accept-Header

응답 파일 형태 (json, xml, text)

- User-Agent

접속 Client (PC / Mobile) 확인

- Accept-Language

언어 확인

3. 응답 상태 코드 활용

- 성공

200 : 성공. body에 응답 내용 전송

201 : 리소스 생성 성공

204 : 성공했지만 응답할 body는 따로 없음

- 실패

400 : 요청 파라미터가 잘못됨. body에 오류 사항을 전송

401 : 인증되지 않는 접근

404 : 존재하지 않은 리소스 접근

405 : 허용하지 않는 method 사용

500 : 서버 오류