[ 06.25 ] REST API

이숙영·2021년 6월 25일

HTTP / 네트워크

목록 보기

3/8

Achivement Goals

🍕 REST API에 대해 이해할 수 있다.
-REST API 문서를 읽을 수 있다.
-REST API에 맞춰 디자인할 수 있다.
-Open API와 API Key에 대해 이해할 수 있다.
🍕 Postman이 무엇인지 이해하고 사용할 수 있다.
-HTTP API 테스팅이 무엇인지 알 수 있다.
-Postman을 사용하여 서버에 GET, POST 요청을 보내고 응답을 받을 수 있다.
-Postman을 사용하여 Open Weather Map Open API에 요청을 보낼 수 있다.

1. REST API란?

클라이언트 사이드 렌더링인 CSR에서는 몇가지의 메소드를 이용해 서버와 통신한다.
GET(데이터 요청) / POST(새로운 데이터 전송) / DELETE(데이터 삭제)..
이렇게 클라이언트의 요청에 따라서 서버가 적절한 응답을 하는 API를 REST API 라고 한다.

🍔 Endpoint

root-endpoint(or root-URL) : API로 서버에 요청할 때, 서버가 요청을 수락하는 시작점을 뜻한다.
일반적으로 도메인 주소의 루트(/) 를 가르킨다.
path(or url-path) : API를 통해 서버와 통신할 때 서버와 통신할 수 있는 key 역할을 한다. 서버에 정의된 문자열에 따라 path 가 달라진다.

(1) 메세지 조회하기 - GET

🍔 request

GET / {githubID}/messages

{githubID} 부분에는 메세지를 조회할 사람의 아이디가 들어간다.
필수적이진 않지만 추가적인 파라미터(query parameter) 를 사용한다면,

/{githubID}/messages?roomname=스위트룸

여기서 파라미터는 roomname 이고 특성 roomname 만 조회할 수 있는, 문자열 형식으로 작성되었다.

🍔 response

응답은 배열객체, JSON 형식으로 쓸 수 있다.
(전부 쌍따옴표로 해야한다. 마이미스테잌.)

[
{'id' : 1, //숫자형태
 'userName':'sook', //이하 문자열형태 
 'text' : 'hi',
 'roomname' : '스위트룸',
 'date' : '2021-06-25T10:34:21:134'
 },
 {'id' : 2, 
 'userName':'mike',
 'text' : 'bye',
 'roomname' : '디럭스룸',
 'date' : '2021-06-25T12:20:45:134'
 },
 ...
]

(2) 메세지 추가하기 - POST

🍔 request

POST /{githubID}/messages

post 로 요청시, username, text,roomname,,추가할 사항을 JSON 형식으로 보낸다.

application/json

🍔 response

위와같이 요청했다면 응답은 이렇게 올 것이다.

{
 "id" : 5;
}

(2) 메세지 초기화하기 - clear

🍔 request

POST /{githubID}/ clear

🍔 response

{
'message' : 'message initialized!'
}

2. REST API 디자인

반드시 어떻게 해야한다~ 라는 공식적인 규격은 없지만 몇가지의 모법적인 사례들은 있다. 그 중 다섯가지 가이드를 들자면,

(1) Resources(URIs)

use concrete names, not action verbs

과거에는

 getUser(1234),createUser(user),deleteAddres(1234)

이렇게 쓰였다면,

GET/users/1234, POST/users(with JSON describing a user in the body) DELETE/addresses/1234

이렇게 쓰는게 추세인가보다.

URI : CamelCase , snake_case, spinal-case

(2) HTTP methods

GET 메소드는 주어진 URI 를 사용하여 정보를 조회,검색할 수 있는 기능이 있다. 그러나 요청시, 데이터만 요청 해야하며 데이터에 다른 영향이 끼치지 않도록 해야한다.
POST 메소드는 고객정보, 파일업로드, HTML form들을 사용하는 다른것들 등등 .. 서버에게 데이터를 보내는것을 요청해야 한다.

(3) HTTP headers

general Header , Client Request Header, Server Response Header, Entity Header(이전포스트에 작성한 부분과 동일)

(4) Query parameters

paging : API 초기 디자인 단계에서 리소스를 예상한다. 만약 많은 양의 데이터가 반환될때 진행상황에 대해 예상하기 어려우므로 기본값으로 리소스 페이지를 매기는 것이 중요하다.
filtering : 필터링은 일부 속성과 예상 값을 지정하여 쿼리 된 리소스 수를 제한하는 것으로 구성된다. 동시에 여러 속성에 대한 컬렉션을 필터링하고 하나의 필터링 된 속성에 여러 값을 허용 할 수 있다.
sorting : 속성의 이름은 쉼표로 구분되어야 한다.
searching : 검색과 관련된 제안, 수정 및 정보를 추가한다. 파라미터는 필터와 동일한 방식이지만 정확한 값이 필수적이진 않다.