[Web] RESTful API란?

RESTful API

• RestApi는 정보들을 주고 받는데 있어서 개발자들이 널리쓰이는 형식이다.
• 요청이 어떤 정보를 위한 것인지를 요청 그 자체로 추론 가능하다.
• URI로 정보의 자원을 표현하고, HTTP Method로 동작을 표현한다.

URI 설계시 주의할 점

• 슬래시 구분자(/)는 계측 관계를 나타내는 것에 사용
  • posts/1/comments
• URI 마지막 문자로 슬래시(/)를 포함하지 않는다. (posts/1/가 아니라 posts/1로 표현한다.)
• 하이픈(-)은 URI 가독성을 높이는데 사용 (게시판이 자유 게시판이라면 free-board 로 가독성을 높힐 수 있다)
• 밑줄(_)은 URI에 사용하지 않는다.
• URI 경로에는 소문자가 적합하다.
• 파일확장자는 URI에 포함하지 않는다.

HTTP METHOD의 알맞은 역할

Method	역할
GET	조회
POST	등록
PUT	전체 수정
PATCH	부분 수정
DELETE	삭제

응답코드

• 1xx : 전송 프로토콜 수준의 정보 교환
• 2xx : 클라어인트 요청이 성공적으로 수행됨
• 3xx : 클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함
• 4xx : 클라이언트의 잘못된 요청
• 5xx : 서버쪽 오류로 인한 상태코드