• REST API란? 자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미 API 또는 애플리케이션 프로그래밍 인터페이스는 애플리케이션이나 디바이스가 서로 간에 연결하여 통신할 수 있는 방법을 정의하는 규칙 세트입니다. REST API는 REST(REpresentational State Transfer) 아키텍처 스타일의 디자인 원칙을 준수하는 API입니다. 이러한 이유 때문에 REST API를 종종 RESTful API라고도 합니다*.*

• 구성 요소 URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용함

  • 자원(Resource): URI 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다. 자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.
  • 행위(Verb): HTTP Method HTTP 프로토콜의 Method를 사용한다. HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.
  • 표현(Representation of Resource) Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다. REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다. JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적

  ---

• 설계

  1. 슬래시 구분자 ( / )는 계층 관계를 나타내는데 사용한다

     ex) http://restapi.example.com/houses/apartments

  2. URI 마지막 문자로 슬래시 ( / )를 포함하지 않는다

     • 즉 URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것
     • 역으로 리소스가 다르면 URI도 달라져야 한다.

  3. 하이픈 ( - )은 URI 가독성을 높이는데 사용한다

  4. 밑줄 ( _ )은 URI에 사용하지 않는다

  5. URI 경로에는 소문자가 적합하다

     • URI 경로에 대문자 사용은 피하도록 한다.

  6. 파일확장자는 URI에 포함하지 않는다

     • REST API 에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.

     • 대신 Accept Header 를 사용한다.

       ex) GET http://restapi.exam.com/member/soccer/345/photo Accept: image/jpg

  7. 리소스 간에 연관 관계가 있는 경우

     • /리소스명/리소스ID/관계가 있는 다른 리소스 명

       ex) GET /users/2/orders (일반적으로 소유의 관계를 표현할 때 사용)

  8. 자원에 대한 행위는 HTTP Method로 표현한다

     • URI에 HTTP Method가 들어가면 안된다

       ex) GET /members/delete/1 (X) → DELETE /members/1 (O)

     • URI에 행위에 대한 동사 표현이 들어가면 안된다

       ex) GET /members/show/1 (X) → GET /members/1 (O) GET /members/insert/2 (X) → POST /members (O)

  9. 경로 부분 중 변하는 부분은 유일한 값으로 대체한다. (:id는 resource의 고유값)

     ex) student를 생성하는 route: POST /students

References

https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html https://www.ibm.com/kr-ko/cloud/learn/rest-apis https://velog.io/@kaitlin_k/restful-API http://www.incodom.kr/RestFul_API https://velog.io/@somday/RESTful-API-이란