HTTP & RESTful HTTP API

김효식 (HS KIM)·2020년 7월 12일

server

wecode

목록 보기

5/35

HTTP 구조 및 핵심 요소

HTTP (HyperText Transfer Protocol)

하이퍼텍스트(HTML) 문서를 교환하기 위해 만들어진 protocol(통신 규약)
- 웹에서 네트워크로 서버끼리 통신을 할 때 서로 통신을 하자고 규정해 놓은 '통신 형식', '통신 구조'다.
- 프론트엔드 서버와 클라이언트간의 통신에 사용된다.
- 백엔드와 프론트엔드 서버간에의 통신에도 사용된다.
HTTP는 TPC/IP 기반으로 되어있다.

HTTP 핵심 요소

HTTP 통신 방식

HTTP는 기본적으로 요청/응답 (request/response) 구조로 되어있다.
- 클라이언트가 HTTP request를 서버에 보내면 서버는 HTTP response를 보내는 구조
- 클라이언트와 서버의 모든 통신은 요청과 응답으로 이루어 진다.
HTTP는 Stateless이다.
- Stateless란 state(상태)를 저장하지 않는다는 뜻이다.
- 요청이 오면 그에 응답을 할뿐, 여러 요청/응답끼리 연결되어 있지 않다. 각각의 요청은/응답은 독립적인 요청/응답이다.
- 클라이언트가 요청을 보내고 응답을 받고, 다시 요청을 보내면, 전에 보낸 요청/응답에 대해 알지 못한다.
- 그래서 여러 요청과 응답의 진행과정이나 데이터가 필요할 때는 쿠키나 세션 등을 사용한다.

HTTP Request 구조

HTTP request 메세지는 3부분으로 구성된다. (status line / headers / body)

Start Line

HTTP request의 첫 라인
HTTP request의 start line도 3부분으로 구성되어 있다.
GET /search HTTP/1.1
- HTTP Method
  - 해당 request가 의도한 action을 정의하는 부분
  - HTTP Mehods에는 GET, POST, PUT, DELETE, OPTIONS 등이 있다.
  - 주로 GET과 POST를 사용한다.
- Request target
  - 해당 request가 전송되는 목표 uri
  - 예를 들어 /login
- HTTP Version
  - HTTP 버전(1.0, 1.1, 2.0)

Headers

해당 request에 대한 추가 정보(addtional information)를 담고 있는 부분
- 예를 들어, request 메세지 body의 총 길이 (Content-Length) 등

Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Type: application/json
Content-Length: 257
Host: google.com
User-Agent: HTTPie/0.9.3

Key:Value 값으로 되어있다.
HOST: google.com / Key = HOST, Value = google.com
Headers도 3부분으로 나뉘지만, 3부분으로 구성되어 있다는 것만 알고 있어도 괜찮다.
자주 사용되는 Headers 정보
- Host
  - 요청이 전송되는 target의 host url: (ex: google.com)
- User-Agent
  - 요청을 보내는 클라이언트에 대한 정보 (ex: 웹브라우저에 대한 정보)
- Accept
  - 해당 요청이 받을 수 있는 응답(response) 타입
- Connection
  - 해당 요청이 끝난후에 클라이언트와 서버가 계속해서 네트워크 커넥션을 유지 할것인지 아니면 끊을 것인지에 대해 지시하는 부분
- Content-Type
  - 해당 요청이 보내는 메세지 body의 타입 (ex: JSON을 보내면 => application/json)
- Content-Length
  - 메세지 body의 길이

Body

해당 request의 실제 메세지/내용
Body가 없는 request도 많다. (ex: GET request들은 대부분 body가 없는 경우가 많음)

POST /payment-sync HTTP/1.1

Accept: application/json
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 83
Content-Type: application/json
Host: intropython.com
User-Agent: HTTPie/0.9.3

{
    "imp_uid": "imp_1234567890",
    "merchant_uid": "order_id_8237352",
    "status": "paid"
}

HTTP Response 구조

Response도 request와 마찬가지로 3부분으로 구성되어 있다. (Status line, Headers, Body)

Status Line

Response의 상태를 간략하게 나타내주는 부분
HTTP/1.1 404 Not Found
3부분으로 구성되어 있다.
- HTTP 버전
- Status code: 응답 상태를 나타내는 코드, 숫자로 되어있는 코드 (ex: 200)
- Status text: 응답 상태를 간략하게 설명해주는 부분 (ex: 'Not Found')

Headers

Response의 headers와 동일하다.
하지만 response에서만 사용되는 header 값들이 있다. (ex: User-Agent => Server 헤더를 사용)

Body

Response의 body와 일반적으로 동일하다.
Requeust와 마찬가지로 모든 response가 body가 있지 않다. 데이터를 전송할 필요가 없을 경우 body가 비어있다.

HTTP/1.1 404 Not Found

Connection: close
Content-Length: 1573
Content-Type: text/html; charset=UTF-8
Date: Mon, 20 Aug 2018 07:59:05 GMT

<!DOCTYPE html>
<html lang=en>
  <meta charset=utf-8>
  <meta name=viewport content="initial-scale=1, minimum-scale=1, width=device-width">
  <title>Error 404 (Not Found)!!1</title>
  <style>
    *{margin:0;padding:0}html,code{font:15px/22px arial,sans-serif}html{background:#fff;color:#222;padding:15px}body{margin:7% auto 0;max-width:390px;min-height:180px;padding:30px 0 15px}* > body{background:url(//www.google.com/images/errors/robot.png) 100% 5px no-repeat;padding-right:205px}p{margin:11px 0 22px;overflow:hidden}ins{color:#777;text-decoration:none}a img{border:0}@media screen and (max-width:772px){body{background:none;margin-top:0;max-width:none;padding-right:0}}#logo{background:url(//www.google.com/images/branding/googlelogo/1x/googlelogo_color_150x54dp.png) no-repeat;margin-left:-5px}@media only screen and (min-resolution:192dpi){#logo{background:url(//www.google.com/images/branding/googlelogo/2x/googlelogo_color_150x54dp.png) no-repeat 0% 0%/100% 100%;-moz-border-image:url(//www.google.com/images/branding/googlelogo/2x/googlelogo_color_150x54dp.png) 0}}@media only screen and (-webkit-min-device-pixel-ratio:2){#logo{background:url(//www.google.com/images/branding/googlelogo/2x/googlelogo_color_150x54dp.png) no-repeat;-webkit-background-size:100% 100%}}#logo{display:inline-block;height:54px;width:150px}
  </style>
  <a href=//www.google.com/><span id=logo aria-label=Google></span></a>
  <p><b>404.</b> <ins>That’s an error.</ins>
  <p>The requested URL <code>/payment-sync</code> was not found on this server.  <ins>That’s all we know.</ins>

자주 쓰이는 HTTP Methods

GET

이름 그대로 특정 데이터를 서버로 부터 받아(GET)올 때 사용하는 Method
데이터 생성/수정/삭제 없이 받아오기만 할 때 사용된다.
가장 많이 사용되는 HTTP Method
주로 데이터를 받아올 때 사용되기 때문에 request에 body를 안보내는 경우가 많다.

POST

데이터를 생성/수정/삭제 할 때 주로 사용되는 Method
데이터를 생성 및 수정 할때 많이 사용하기 때문에 대부분 request body가 포함되서 보내진다.

자주 쓰이지는 않지만 알고 있으면 좋은 HTTP Methods####

OPTIONS

주로 요청 URI에서 사용할 수 있는 Method를 받아올 때 사용된다.
/update uri에서 어떤 method를 요청 가능한지 알고 싶으면, 먼저 OPTIONS를 통해 확인한다.

http -v OPTIONS http://example.org

OPTIONS / HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 0
Host: example.org
User-Agent: HTTPie/0.9.3



HTTP/1.1 200 OK
Allow: OPTIONS, GET, HEAD, POST
Cache-Control: max-age=604800
Content-Length: 0
Date: Mon, 20 Aug 2018 08:37:45 GMT
Expires: Mon, 27 Aug 2018 08:37:45 GMT
Server: EOS (vny006/0450)

PUT

데이터를 생성할 때 사용되는 Method로 POST와 비슷하다.
POST와 겹치기 때문에 PUT을 사용하는 곳도 있고, POST만 사용하는 곳도 있는데, 최근에는 POST에 밀려서 잘 사용하지 않는 추세다.

DELETE

특정 데이터를 서버에서 삭제 요청을 보낼 때 사용하는 Method다.
PUT과 마찬가지로 POST에 밀려서 잘 사용하지 않는 추세다.

자주 쓰이는 HTTP Status Code

200 OK

가장 자주 보게되는 status code, 문제없이 다 잘 실행되었을 때 보내는 코드

301 Moved Permanently

해당 URI가 다른 주소로 바뀌었을때 보내는 코드

400 Bad Request

해당 요청이 잘못된 요청일대 보내는 코드
주로 요청에 포함된 input 값들이 잘못된 값들이 보내졌을때 사용되는 코드
예를 들어, 전화번호를 보내야 되는데 text가 보내졌을때 등

401 Unauthorized

유저가 해당 요청을 진행 할려면 먼저 로그인을 하거나 회원 가입을 하거나 등등이 필요하다는것을 나타내려 할때 쓰이는 코드

403 Forbidden

유저가 해당 요청에 대한 권한이 없다는 뜻
예를 들어, 오직 과금을 한 유저만 볼 수 있는 데이터를 요청 했을때 등

404 Not Found
요청된 uri가 존재 하지 않는다는 뜻

http -v google.com/no-such-uri

GET /no-such-uri HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Host: google.com
User-Agent: HTTPie/0.9.3

HTTP/1.1 404 Not Found
Content-Length: 1572
Content-Type: text/html; charset=UTF-8
Date: Mon, 20 Aug 2018 08:46:48 GMT
Referrer-Policy: no-referrer

500 Internal Server Error

서버에서 에러가 났을때 사용되는 코드
API 개발을 하는 백앤드 개발자들이 싫어하는 코드

RESTful HTTP API 구조 및 핵심 개념

기본 배경 지식

URI (Uniform Resource Identifier)
- 해당 사이트의 특정 자원의 위치를 나타내는 유일한 주소
- /login, /news
- https://finance.naver.com/marketindex/
HTTP Mehotd
- HTTP request가 의도하는 action을 정의한 것
- POST, GET 등
Payload
- HTTP requeest에서 보내는 데이터 (body)

Representational State Transfer

웹상에서 사용되는 여러 리소스를 HTTP URI로 표현하고, 그 리소스에 대한 행위를 HTTP Method로 정의하는 방식
- 리소스(HTTP URI) => HTTP Method + Payload 를 구조적으로 깔끔하게 표현하는 것
- Method는 주로 GET, POST만 사용한다.
- PUT, DELETE 등을 사용하는 곳도 있지만, 최근에는 GET과 POST만 사용하는 추세다.
- ex : 삼성전자 주식 정보를 받기 위한 HTTP 요청
  - HTTP GET https://api.trueshort.com/stock/005930
- 유저의 보유 주식 종목들을 DB에 저장하는 HTTP 요청

HTTP POST https://api.trueshort.com/user/portfolio
{
    "user_id" : 1,
    "stocks": [ 
        "005930",
        "298730",
        "378900"
    ]
}

RESTful API의 장점

가장 명확한 장점은 self-descriptiveness이다.
RESTful API는 그 자체만으로도 API의 목적이 쉽게 이해가 된다.
- 위의 HTTP GET https://api.trueshort.com/stock/005930 요청의 경우, 문서나 줏거의 없이도 https://api.trueshort.com 라는 API에서 삼성전자 주식에 관한 정보를 HTTP요청을 통해 받아온다는 것을 예상하고, 쉽게 해석이 가능하다.

RESTful API를 개발할 때 유의할 점

/는 계층 관계를 나타낸다.
- https://api.trueshort.com/kospi/stock/005930 에서, KOSPI에 속해있는 주식(stock) 중 삼성전자(005930)을 나타내는 구조다.
- https://api.shopping.com/books/novel/stephenking 에서, 책들중 소설 그리고 소설중 Stephen King의 소설을 나타내는 구조다.
URI에 _는 주로 포함하지 않고 영어는 대문자보다 소문자를 쓴다.
URI는 명사를 사용한다.
- 동사는 GET, POST 같은 HTTP Method를 통해 표현하기 때문이다.

김효식 (HS KIM)

자기개발 :)

이전 포스트

Database

다음 포스트

자료구조: Array

2개의 댓글

yojuyoon

2020년 7월 17일

오타 수정해주세요

1개의 답글