넷상에 싸지르는 공개처형 일기장

CodeStates/Node.js

[Server] REST API & Postman

디스페어 2022. 4. 4.

REST(Representational State Transfer) API

  • REST API : HTTP API를 만드는 방법론으로 웹(http)의 장점을 최대한 활용할 수 있는 API의 대표적인 아키텍처
    Architecture(아키텍처) : 컴퓨터 시스템의 하드웨어 구조로 컴퓨터 시스템을 구성하고 있는 하드웨어 장치인 CPU, 레지스터, 기억장치, 입출력 장치 등과 같은 여러 가지 컴퓨터 구성 요소들에 대한 전반적인 기계적 구조와 이를 설계하는 방법
  • 웹에서 사용되는 모든 자원을 HTTP URI로 표현하고, HTTP Method를 통해 요청과 응답을 정의하는 방식

 

 

REST 구성

  • 자원(Resource) - URI
  • 행위(Verb) - HTTP Method
  • 표현(Representations)

 

 

REST의 특징

1. Uniform (유니폼 인터페이스)

  • Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일

 

2. Stateless (무상태성)

  • 작업을 위한 상태정보를 따로 저장하고 관리하지 않으며, 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 되서 서비스의 자유도가 높아지고, 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해짐

 

3. Cacheable (캐시 가능)

  • HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용 가능 (HTTP가 가진 캐싱 기능이 적용 가능)
  • HTTP 프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용하면 캐싱 구현 가능

 

4. Self-descriptiveness (자체 표현 구조)

  • REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어있음

 

5. Client - Server 구조

  • REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 됨

 

6. 계층형 구조

  • REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 함

 

 

REST API 디자인 가이드

첫 번째, URI는 정보의 자원을 표현함
두 번째, 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현함

 

1. REST API 중심 규칙

1-1. URI는 정보의 자원을 표현함 (리소스명은 동사보다는 명사를 사용)

    GET /members/delete/1
  • 위와 같은 방식은 REST를 제대로 적용하지 않은 URI로써 URI는 자원을 표현하는데 중점을 두어야 함
    *delete와 같은 행위에 대한 표현이 들어가서는 안됨

 

1-2. 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)로 표현

    DELETE /members/1
  • 회원정보를 가져올 때는 GET, 회원 추가 시의 행위를 표현하고자 할 때는 POST METHOD를 사용하여 표현함

 

1-3. 회원정보를 가져오는 URI

    GET /members/show/1     (x)
    GET /members/1          (o)

 

1-4. 회원을 추가할 때

    GET /members/insert/2 (x)  - GET 메서드는 리소스 생성에 맞지 않습니다.
    POST /members/2       (o)

 

 

2. URI 설계 시 주의할 점

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

    http://restapi.example.com/houses/apartments
    http://restapi.example.com/animals/mammals/whales

 

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

  • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다
  • REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다
    http://restapi.example.com/houses/apartments/ (X)
    http://restapi.example.com/houses/apartments  (0)

 

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

  • URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있다

 

2-4. 밑줄(_)은 URI에 사용하지 않음

  • 글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하며, 이런 문제를 피하기 위해 밑줄 대신 하이픈(-)을 사용하는 것이 좋다(가독성)

 

2-5. URI 경로에는 소문자가 적합

  • URI 경로에 대문자 사용은 피하도록 해야 하는데 대소문자에 따라 다른 리소스로 인식하게 됨
  • RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정
    RFC 3986 is the URI (Unified Resource Identifier) Syntax document

 

2-6. 파일 확장자는 URI에 포함시키지 않음

    http://restapi.example.com/members/soccer/345/photo.jpg (X)
  • REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않으니 Accept header를 사용하도록 한다
    GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

 

 

3. 리소스 간의 관계를 표현하는 방법

REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같은 표현방법으로 사용

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

    ex)    GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

REST 리소스 간에는 연관 관계가 있을 수 있지만 만약 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법이 있다

 

    GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)

Ex)사용자가 ‘좋아하는’ 디바이스 목록을 표현해야 할 경우 다음과 같은 형태로 사용될 수 있음

 

 

4. 자원을 표현하는 Colllection과 Document

  • Collection과 Document에 대해 알면 URI 설계가 한 층 더 쉬워진다
  • DOCUMENT는 단순히 문서로 이해해도 되고, 한 객체라고 이해해도 되며 컬렉션은 문서들의 집합, 객체들의 집합이라고 생각하면 된다
  • 컬렉션과 도큐먼트는 모두 리소스라고 표현할 수 있으며 URI에 표현된다
//sports라는 컬렉션과 soccer라는 도큐먼트로 표현
    http:// restapi.example.com/sports/soccer
//sports, players 컬렉션과 soccer, 13(13번인 선수)를 의미하는 도큐먼트로 URI가 이루어지게 된다
//직관적인 REST API를 위해서는 컬렉션과 도큐먼트를 사용할 때 단수 복수도 지켜준다면 
//이해하기 쉬운 URI를 설계할 수 있다
    http:// restapi.example.com/sports/soccer/players/13

 

 

문서 읽기

1. Endpoint

https://api.github.com : Github API의 root-endpoint
  • root-endpoint(혹은 root-URL): API로 요청을 서버와 통신할 때, 서버가 요청을 수락하는 시작점
    *일반적으로 도메인 주소의 루트(/)를 나타냄
https://api.github.com/user : 'user'가 path
  • path: path(또는 url-path)는 API를 통해 서버와 통신할 때, 서버와 통신할 수 있는 key 역할 수행
    *서버에 정의된 문자열에 따라 path가 달라짐

 

 

2. 메시지 조회

2-1. Request

GET /{githubID}/messages

//{githubID} : 요청하는 사람의 아이디를 작성
//GET /GR72/messages

GET /MSI/messages?roomname=바나나타운
//MSI가 작성한 메시지 중 방 이름(roomname)이 바나나타운인 것만 조회
  • githubID가 작성한 모든 메시지를 조회
  • 추가적인 파라미터(query parameter) 사용 가능

 

2-2. Response

[
  {
    "id": 1,
    "username": "MSI",
    "text": "저세상 리눅스 호환성",
    "roomname": "바나나타운",
    "date": "2022-03-15T10:11:05.105"
  },
  // ...여러 개의 메시지
]
  • id : 고유 아이디
  • username : 사용자 이름
  • text : 본문 내용
  • roomname : 방 이름
  • date : 작성 시간

 

 

3. 메시지 추가

3-1. Request

POST /{githubID}/messages

POST /MSI/messages
  • 메시지는 24시간마다 자동으로 리셋됨
  • username, text, roomname 필수 작성
  • 요청 형식 : JSON(application/json)

 

3-2. Response

{
  "id": 5
}
  • 새로 생성된 메시지의 고유한 ID값이 응답으로 옴

 

 

4. 메시지 초기화

4-1. Request

POST /{githubID}/clear

POST /MSI/clear
  • 요청 본문은 필요하지 않음

 

4-2. Response

{
  "message": "message initialized!"
}
  • JSON 형식으로 응답이 옴

 

 

문서 디자인하기

API 작성 가이드
1. 5가지의 기본적인 REST API 디자인 가이드
2. 호주 정부 API 작성 가이드
3. 미국 백악관 API 작성 가이드
4. 구글 API 작성 가이드
  • URI : 정보의 자원을 표현
  • 자원에 대한 상태 정의 : HTTP method(GET, POST, PUT, DELETE...)로 표현
    *POST /user/1122처럼 표현

 

 

Open API와 API Key

1. Open API

  • 누구에게나 열려있는 API : 무제한으로 이용할 수 있는 것은 아님
  • 기관이나 API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있음
  • 공공데이터포털 : 공공데이터에 쉽게 접근할 수 있도록 정부는 Open API의 형태로 공공데이터를 제공
  • Open Weather Map : 날씨 API
    *프리 플랜 : 기본적으로 분당 60번, 달마다 1백 번 호출 가능, 데이터를 JSON 형태로 응답

 

2. API Key

  • API를 이용하기 위해서는 API Key가 필요
  • 로그인된 이용자에게만 자원에 접근할 수 있는 권한을 API Key의 형태로 제공, 데이터를 요청할 때 API key를 같이 전달해야만 원하는 응답을 받을 수 있음

 

 

Postman

  • HTTP API 테스트 도구로 HTTP 요청을 테스트할 수 있음
  • 많은 API가 HTTP 프로토콜을 이용하므로, API 테스트 도구라고 부름
HTTP API 테스트 도구 (CLI)
curl (대부분의 리눅스 환경에 내장)
wuzz

HTTP API 테스트 도구 (GUI)
Postman
Insomnia

 

 

1. Postman 화면 구성

  1. 새로운 탭 오픈
    *요청, 응답을 여러개 확인할 수 있음
  2. HTTP 메소드 선택
    *GET, POST, DELETE 등과 같은 메소드 중 하나를 선택
  3. URL 입력 창
    *URL과 Endpoint를 입력
  4. HTTP 요청 버튼
  5. HTTP 요청시 설정할 수 있는 각종 옵션
    *추가적인 파라미터나, 요청 본문(body)을 추가할 수 있음
  6. HTTP 응답 화면

 

 

2. 본문을 포함한 POST 요청

  • 본문의 형식 : JSON 형식으로 보낼 때에는, raw를 선택
    *HTTP 요청 헤더에 Content-Type: application/json이라 작성하는 것과 동일
  • 본문 내용 : JSON 형식을 선택했으므로 유효한 JSON을 적어줌
    *API 문서에 따라 형식에 맞게 작성

 

 

Chrome Network Tab

1. 필요성

  • 크롬 개발자 도구가 열려있는 상태에서 새로고침을 하면 네트워크 활동 확인 가능
  • 네트워크 활동에 대한 시간순 로그와 총 요청 수와 전송된 총 데이터 양을 보여줌
    *네트워크 로그 : 네트워크 요청이 예상대로 진행되고 있는지 확인하는 데 도움을 줌
  • 개발자 도구가 열려있는 한 로그에 네트워크 활동이 계속 기록됨
    *필요한 모든 정보가 있는 경우 기록중지 버튼 클릭(빨간색)
  • 요청 차단 : 개별 리소스를 차단하고 해당 리소스를 사용할 수 없을 때 페이지가 어떻게 작동하는 지를 보여줌
  • 필터링, 검색 등을 통해 원하는 로그만 찾아볼 수 있음

 

 

2. 네트워크 로그 기본 구성

  • Name : 클릭 시 리소스에 대한 자세한 내용을 볼 수 있음
  • Status : 서버가 반환한 HTTP 응답 코드
  • Type : 리소스 유형
    *클릭 시 타입별로 정렬
  • Initiator : 리소스를 요청한 원인
  • Size : 리소스의 크기
    *리소스가 압축되었는지 확인할 때 유용(위 : 원본 크기, 아래 : 압축된 크기)
  • Time : 브라우저에서 리소스를 업로드 하거나 다운로드 하는 데 걸린 시간
  • Waterfall : 각 리소스의 네트워크 활동에 대한 시각적 요약
    *커서를 대면 여러 단계의 분석이 표시, 클릭 시 시간순으로 정렬

 

 

References

Chrome Network Tab 사용법

반응형
저작자표시 비영리

'CodeStates > Node.js' 카테고리의 다른 글

[Server] node.js를 이용한 서버 구현  (0) 2022.04.04
[Server] 브라우저 작동원리  (0) 2022.03.27
[Server] HTTP를 이용한 클라이언트-서버 아키텍처  (0) 2022.03.26

댓글

티스토리툴바