REST API디자인 가이드

REST API설계 시 가장 중요한 항목은 다음의 2가지가 있다.

1. URI는 정보의 자원을 표현해야 한다.
2. 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현해야 한다.

1) URI는 정보의 자원을 표현 해야 한다.

• GET/members/delete/1

위 URI난 REST를 제대로 적용하지 않았다.
-> delete같은 행위가 들어가서는안됨
명사로 구성 되어야 한다.

회원 정보를 가져올 떄는 GET, 회원 추가 시의 행위를 표현하고자 할 떄는 POST METHOD를 사용한다.

참고사항

POST : POST를 통해서 요청하면 리소스를 생성한다.
GET : GET를 통해 리소스를 조회한다. 정보를 가져온다.
PUT : 리소스를 수정한다.
DELETE : 리소스를 삭제한다.

URI 설계시 주의할 점

몇가지 사항들이 있다.
필수는 아니기 떄문에 습관적으로 확인해볼것이며 익숙해지면 된다고 생각.(검색을 이용)

HTTP 응답 상태코드

상태 코드또한 다양하다.
기본적인 것만을 정리하자면

200 : 정상적 수행
201 : 정상적 수행 후 리소스 생성

400 : 요청이 부적절하다.
401 : 인증되지 않은 상태에서 보호된 리소스를 요청

301 : UR가 변경 되었을떄

500 : 서버에 문제가 발생

대략 이정도 이며 후에 내가 서버쪽을 좀더 공부를 하게 된다면 수정 및 추가를 해볼 예정이다.