REST API

REST API

API란?

클라이언트와 서버와의 통신에서 클라이언트가 각 서버에 맞는 요청을 할 수 있도록 만들어진 서버 사용법이다.
이 API를 체계적으로 정리하여 규칙을 만든 것이 REST API다.

---

REST API 기본적인 작성 5단계

1. 리소스를 설명할 땐 동사가 아닌 명사를 사용한다.
   • 리소스의 이름을 사용할 땐 Spinal-case를 권장한다.
2. HTTP 메소드를 사용할 땐 반복사용을 금지한다.
3. HTTP 헤더 필드는 요청이나 응답, 또는 메시지 본문에서 보낸 객체에 대한 필수 정보를 제공한다.
4. Query 매개변수를 사용한다.
5. 알맞은 상태코드를 사용한다.
   • 200 - OK
   • 201 - CREATED
   • 204 - NO CONTENT 성공적으로 지웠다.
   • 304 - NOT MODIFIED 데이터가 바뀌지 않았다. 중복요청
   • 400 - BAD REQUEST
   • 401 - UNATHORIZED
   • 403 - FORBIDDEN
   • 404 - NOT FOUND
     • 400번대는 모두 클라이언트의 잘못이다.
   • 500 - INTERNAL SERVER ERROR 서버의 문제