REST API

의미

💡 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해서 요청과 응답을 정리하는 방식

Richardson 성숙도 모델(RMM)

단계	내용
0단계	HTTP 사용
1단계	개별 리소스와의 통신 준수
2단계	HTTP 메소드 원칙 준수
3단계	HATEOAS 원칙 준수

*2단계까지만 충족해도 좋은 API 디자인이라고 할 수 있고 HTTP API라고 함

📗 0단계
단순히 HTTP 프로토콜을 사용하는 것
단 하나의 endpoint(/appointment)에서 서로 다른 매개변수를 전달하며 작동.
매개변수를 body로 전달하기 위해 HTTP Method는 POST를 사용

요청	응답
POST /appointment HTTP 1.1 //헤더 생략// {     "name" : "a"     "date" : "2022-12-02" }	HTTP 1.1 200 OK //헤더 생략// {     "slots" : [       {"id" : "1", "name" : "a", "time" : "09:00"}       {"id" : "2", "name" : "a", "time" : "10:00"}     ] }

요청	응답
POST /appointment HTTP 1.1 //헤더 생략// {     "name" : "a"     "time" : "09:00"     "patient" : "A" }	HTTP 1.1 200 OK //헤더 생략//

📗 1단계
개별 리소스에 맞는 endpoint 사용(/doctors/a)
요청하고 받는 리소스에 대한 정보를 응답으로 전달해야 함

요청	응답
POST /doctors/a HTTP 1.1 //헤더 생략// {     date : "2022-12-02" }	HTTP 1.1 200 OK //헤더 생략// {     "slots" : [       {"id" : "1", "name" : "a", "time" : "09:00"}       {"id" : "2", "name" : "a", "time" : "10:00"}     ] }

요청	응답
POST /slots/1 //헤더 생략// {     patient : "A" }	HTTP 1.1 200 OK {     "appointment" : {         "slot" : {"id" : "1", "name" : "a", "time" : "09:00"},         "patient" : "A"     } }

📗 2단계
CRUD에 적합한 HTTP 메소드를 사용

요청	응답
GET /doctors/a/slots?date=2022-12-02 //헤더 생략//	HTTP 1.1 200 OK //헤더 생략// {     "slots" : [       {"id" : "1", "name" : "a", "time" : "09:00"}       {"id" : "2", "name" : "a", "time" : "10:00"}     ] }

* query parameter를 사용하여 필요한 리소스를 전달

요청	응답
POST /slots/1 //헤더 생략// {     patient : "A" }	HTTP 1.1 201 Created Location: /slots/1/appointment {     "appointment" : {         "slot" : {"id" : "1", "name" : "a", "time" : "09:00"},         "patient" : "A"     } }

◾️ GET : 서버의 데이터를 변화시키지 않는 요청에 사용
◾️ POST : 요청마다 새로운 리소스 생성
◾️ PUT : 요청마다 같은 리소스 반환(멱등성), 교체
◾️ PATCH : 수정

📗 3단계
2단계와 거의 동일하나 응답에는 리소스의 URI를 포함한 링크 요소를 삽입해야함
이 때 링크요소는 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것

요청	응답
GET /doctors/a/slots?date=2022-12-02 //헤더 생략//	HTTP 1.1 200 OK //헤더 생략// {     "slots" : [       {"id" : "1", "name" : "a", "time" : "09:00"}       {"id" : "2", "name" : "a", "time" : "10:00"}     ],     "links" : {       "appointment" : {         "href" : "http://localhost:8080/slots/1",         "method" : "POST"         }       } }

요청

응답

POST /slots/1 //헤더 생략// {     patient : "A" }

HTTP 1.1 201 Created Location: /slots/1/appointment {     "appointment" : {         "slot" : {"id" : "1", "name" : "a", "time" : "09:00"},         "patient" : "b"     },     "links" : {       "self" : {         "href" : "http://localhost:8080/slots/1",         "method" : "GET"         }       },       "cancel" : {         "href" : "http://localhost:8080/slots/1/cancel",         "method" : "DELETE"         }       } }

Open API

💡 누구에게나 열려있지만, 정해진 이용수칙에 따라 제한(가격, 정보의 제한 등)이 존재함

예) Open Weather Map - 날씨 정보 제공, JSON형태로 응답

API Key

💡 API를 이용하기 위한 것
💡 로그인한 이용자에게 리소스에 대한 접근 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API Key를 전달하면, 응답을 받을 수 있음

참고

REST API 성숙도 모델 (Maturity Model)
Richardson 성숙도 모델
코드스테이츠 교과서