Dev Diary.

3xx (Redirection)

요청을 완료하기 위해 유저 에이전트의 추가 조치 필요

300 Multiple Choices

301 Moved Permanently

302 Found

303 See Other

304 Not Modified

307 Temporary Redirect

308 Permanent Redirect 

리다이렉션 이해

 웹 브라우저는 3xx 응답의 결과에 Location 헤더가 있으면, Location 위치로 자동 이동

예를 들어 /event 이벤트 페이지를 하나 만들고 더 이상 쓰지 않게되어

/new-event라는 새로운 이벤트 페이지를 만들었다 

기존에 사용하던 사용자들은 북마크 등등을 통해 /event로 접속을 한다.(GET)

서버에 입장에서는 더 이상 안쓰는 페이지이기때문에 Location에 /new-event를 알려준다.(301 코드)

이제 클라이언트 입장에서는 3xx대 응답, Location필드를 보고 웹 브라우저가 스스로 /new-event로 다시 요청을한다.

서버는 200 OK를 보낸다.

사용자 입장에서는 너무 빨라 인식하기 어렵다.

종류

영구 리다이렉션 - 특정 리소스의 URI가 영구적으로 이동 

  예) /members -> /users

       /event -> /new-event

일시 리다이렉션 - 일시적인 변경

  -주문 완료 후 주문 내역 화면으로 이동

  -PRG : Post/Redirect/Get

특수 리다이렉션

 -결과 대신 캐시를 사용

영구 리다이렉션

301, 308

리소스의 URI가 영구적으로 이동

원래의 URI를 사용하지 않고, 검색 엔진 등에서도 변경 인지

301 Moved Permanently

  - 리다이렉트시 요청 메서드가 GET으로 변하고, 본문이 제거될 수 있음

308 Permanent Redirect

  - 301과 기능은 같은

  - 리다이렉트시 요청 메서드와 본문 유지

/event 라고 POST 요청을 보낸다 (바디에 데이터 포함)

서버는 /event를 이제 쓰지 않으니 301요청을 Location에 /new-event를 보낸다.

클라이언트에서 URL을 자동으로 바꾼다. 이때 요청 메서드가 GET으로 변경된다.

등록을 하기를 원해서 POST로 보냈지만 GET으로 날아가며 메시지 바디부분에 데이터가 사라진다.

(새로 데이터를 입력해야하는 화면이 나오게된다.)

과정은 301과 동일하지만 POST를 유지 하며 자동 리다이렉트가 되며

데이터가 등록이 될 것이다. 설명을 위해서 예를든것이지 실무에서는 이런 상황에서 308을 쓰지 않는다.

왜냐하면 데이터가 다 바뀌어 버리기 때문이다. 사실 영구 리다이렉션 사실 영구 리다이렉션보다 일시적인 리다이렉션을 많이 사용한다.

2xx(Successful)

클라이언트의 요청을 성공적으로 처리

200 OK

 - 요청 성공

201 Created

 - 요청 성공해서 새로운 리소스가 생성됨

 - 신규 자원 등록 시 POST의 경우에 서버에서 자원을 생성하고 URI관리도 서버에서 하는데 이때

   생성된 리소스는 응답의 Location 헤더 필드로 식별한다. 

202 Accepted

 - 요청이 접수되었으나 처리가 완료되지 않았음

 - 배치 처리 같은 곳에서 사용

 - 예) 요청 접수 후 1시간 뒤에 배치 프로세스가 요청을 처리함

204 No Content

 - 서버가 요청을 성공적으로 수행했지만, 응답 페이로드 본문에 보낼 데이터가 없음

 - 예) 웹 문서 편집기에서 save 버튼

 - save 버튼의 결과로 아무 내용이 없어도 된다.

 - save 버튼을 눌러도 같은 화면을 유지해야 한다.

 - 결과 내용이 없어도 204메시지 만으로 성공을 인식할 수 있다.

회원 관리 시스템

API 설계 - POST 기반 등록

회원 목록 /members -> GET

회원 등록 /members -> POST

회원 조회 /members/{id} -> GET

회원 수정 /members/{id} -> PATCH,PUT,POST

회원 삭제 /members/{id} -> DELETE

-POST 신규 자원 등록 특징

  클라이언트는 등록될 리소스의 URI를 모른다.

    회원 등록 /members -> POST  

  POST /members

  서버가 새로 등록된 리소스 URI를 생성해준다.

    HTTP/1.1 201 Created

    Location: /members/100

  컬렉션

    서버가 관리하는 리소스 디렉토리

    서버가 리소스의 URI를 생성하고 관리

    여기서 컬렉션은 /members

파일 관리 시스템

API 설계 - PUT 기반 등록

파일 목록 /files -> GET

파일 조회 /files/{filename} -> GET

파일 등록 /files/{filename} -> PUT

파일 삭제 /files/{filename} -> DELETE

파일 대량 등록 /files -> POST

PUT - 신규 자원 등록 특징

  클라이언트가 리소스 URI를 알고 있어야 한다.(파일 등록 시 파일이름을 넣어줘야 한다.)

    파일 등록 /files/{filename} -> PUT

    PIUT /files/star.ipg

  클라이언트가 직접 리소스의 URI를 지정한다.

  스토어

    클라이언트가 관리하는 리소스 저장소

    클라이언트가 리소스의 URI를 알고 관리

    여기서 스토어는 /files

HTML FORM 사용

HTML FORM은 GET, POST만 지원

AJAX 같은 기술을 사용하여 해결 가능 -> 회원 API 참고

여기서는 순수 HTML, HTML FORM 이야기

GET, POST만 지원하므로 제약이 있음

회원 목록     /members -> GET

회원 등록 폼 /members/new -> GET

회원 등록     /members/new, /members -> POST

회원 조회     /members/{id} -> GET

회원 수정 폼 /members/{id}/edit -> GET

회원 수정     /members/{id}/edit, /members/{id} -> POST

회원 삭제     /members/{id}/delete -> POST

컨트롤 URI

  GET, POST만 지원하므로 제약이 있음

  이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용

  POST의 /new, /edit, /delete가 컨트롤URI

  HTTP 메서드로 해결하기 애매한 경우 사용

데이터 전달 방식은 크게 2가지

쿼리 파라미터를 통한 데이터 전송

GET

주로 정렬 필터(검색어)

메시지 바디를 통한 데이터 전송

POST, PUT, PATCH

회원 가입, 상품 주문, 리소스 등록, 리소스 변경

4가지 상황

정적 데이터 조회

- 이미지, 정적 텍스트 문서

- 조회는 GET 사용

- 정적 데이터는 일반적을 쿼리 파라미터 없이 리소스 경로로 단순하게 조회가능

동적 데이터 조회

- 주로 검색, 게시판 목록에서 정렬 필터(검색어)

- 조회 조건을 줄여주는 필터, 조회 결과를 정렬하는 정렬 조건에 주로 사용

- 조회는 GET 사용

- GET은 쿼리 파라미터 사용해서 데이터를 전달 

HTML Form 데이터 전송

-HTML Form submit시 POST 전송

  예) 회원가입, 상품 주문, 데이터 변경

-Content-Type : application/x-www-form-urlencoded 사용

  form의 내용을 메시지 바디를 통해서 전송(key=value, 쿼리 파라미터 형식)

  전송 데이터를 url encoding 처리

-HTML Form은 GET 전송도 가능

-Content-Type : multipart/form-data

  파일 업로드 같은 바이너리 데이터 전송시 사용

  다른 종류의 여러 파일과 폼의 내용을 함께 전송 가능

-참고: HTML Form전송은 GET, POST만 지원

HTML API 데이터 전송

-서버 to 서버

  백엔드 시스템 통신

-앱 클라이언트

  아이폰, 안드로이드

-웹 클라이언트

  HTML 에서 Form 전송 대신 자바 스크립트를 통한 통신에 사용(AJAX)

  예) React, VueJs 같은 웹 클라이언트와 API 통신

-POST, PUT, PATCH : 메시지 바디를 통해 데이터 전송

-GET : 조회, 쿼리 파라미터로 데이터 전달

-Content-Type : application/json을 주로 사용

  TEXT, XML, JSON 등등

안전

멱등

캐시 가능

안전

호출해도 리소스를 변경하지 않는다.

POST, DELETE, PUT, PATCH 같은 메서드는 호출했을때 변경이 일어나기 때문에 안전하지 않다.

계속 호출하여 로그가 쌓이며 장애가 발생한다면?

안전은 그런 부분까지 고려하지 않고 해당 리소스만 고려한다.

멱등

f(f(x)) = f(x)

한번 호출하든 두번 호출하든 100번 호출하든 결과가 똑같다.

멱등 메서드

GET : 여러번 조회를 해도 같은 결과가 조회된다.

PUT : 같은 요청을 여러번 해도 최종 결과는 같다.

DELETE : 결과를 삭제한다. 여러번 하여도 삭제된 결과는 가탇.

POST : 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.

활용

자동 복구 매커니즘

예를 들어 DELETE 호출했는데 서버에서 응답이 없다.

그렇다면 클라이언트가 자동으로 DELETE를 호출한다고 해도 결과가 같기 때문에 상관이없다.

예를들어 

재요청 중간에 다른 곳에서 리소스를 변경해버리면?

사용자 1 GET -> user:A, age:20

사용자 2 PUT -> user:A, age:30

사용자1  GET -> user:A, age:30 (사용자 2의 영향으로 바뀐 데이터 조회)

멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지는 고려하지 않는다.

캐시가능

응답 결과 리소스를 캐시해서 사용해도 되는가?

GET, HEAD, POST, PATCH 캐시가능

실제로는 GET, HEAD 정도만 캐시로 사용

- POST,PATCH 본문 내용까지 캐시 키로 고려해야 하는데 구현이 쉽지 않다.

PUT

리소스를 대체

- 리소스가 있으면 대체

- 리소스가 없으면 생성

- 쉽게 이야기해서 덮어버림

클라이언트가 리소스를 식별

- 클라이언트가 리소스 위치를 알고 URI 지정(POST와의 차이점이다)

PATCH

리소스를 부분 변경

DELETE

리소스를 제거

리소스를 부분변경할때 PATCH가 지원이 안된다면

POST를 쓰면 된다.

HTTP 메서드는 클라이언트가 서버에게 요청을할때 기대하는 행위이다.

주요메서드

GET : 리소스 조회

POST : 요청 데이터 처리, 주로 등록에 사용

PUT : 리소스를 대체, 해당 리소스가 없으면 생성

PATCH : 리소스 부분 변경

DELETE : 리소스 삭제

기타메서드

HEAD : GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환

OPTIONS : 대상 리소스에 대한 통신 가능 옵션

CONNECT : 대상 자원으로 식별되는 서버에 대한 터널을 설정

TRACE : 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행

GET

리소스 조회

서버에 전달하고 싶은 데이터는 query를 통해서 전달

메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음

POST

요청 데이터 처리

메시지 바디를 통해 서버로 요청 데이터 전달

서버는 요청 데이터를 처리

  메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.

주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용

요청 데이터를 어떻게 처리한다는 뜻일까? 

스펙 : POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포한된 표현을 처리하도록 요구합니다.

예를들어 POST는 다음과 같은 기능에 사용됩니다.

-HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공

-게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시

-서버가 아직 식별하지 않은 새 리소스 생성

-기존 자원에 데이터 추가

이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리해야할지 따로 정해 놓아야 한다.

1. 새 리소스 생성 

- 서버가 아직 식별하지 않은 새 리소스 생성

2. 요청 데이터 처리

- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우

예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우

POST의 결과롤 새로운 리소스가 생성되지 않을 수도 있음

3. 다른 메서드로 처리하기 애매한 경우

예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우

처음으로  HTTP API를 설계해보았다.

요구사항

회원 정보 관리 API를 만들어라.

회원 목록 조회

회원 조회

회원 등록

회원 수정 

회원 삭제 

API URI 설계

회원 목록 조회 /read-member-list

회원 조회 /read-member-by-id

회원 등록 /create-member

회원 수정 /update-member

회원 삭제 /delete-member

이것은 좋은 URI 설계일까?

가장 중요한 것은 리소스 식별이다.

API URI 고민

리소스의 의미는 뭘까?

  회원을 등록하고 조회하고 수정하는 것이 리소스가 아니다.

  회원이라는 개념 자체가 리소스다.

리소스는 어떻게 식별하는게 좋을까?

  회원을 등록하고 수정하고 조회하는 것을 모두 배제

  회원이라는 리소스만 식별하면 된다. > 회원 리소스를 URI에 매핑

회원 목록 조회 /members

회원 조회 /members/{id}

회원 등록 /members/{id}

회원 수정 /members/{id}

회원 삭제 /members/{id}

조회,등록,수정,삭제를 어떻게 구분하지???

리소스와 행위를 분리

가장 중요한 것은 리소스를 식별하는것

URI는 리소스만 식별

리소스와 해당 리소스를 대상으로 하는 행위를 분리

 리소스:회원

 행위:조회,등록,삭제,변경

리소스는 명사, 행위는 동사

행위는 어떻게 구분하지?

모든 것이 HTTP 

HTTP 메시지에 모든 것을 전송할 수 있다.

시작라인 

크게 request-line / status-line으로 나뉜다.

start-line = request-line/status-line

요청 메시지

request-line = method SP(공백) request-target SP HTTP-version CRLF(엔터)

-HTTP 메서드

  종류 :  GET, POST, PUT, DELETE...

  서버가 수행해야 할 동작 지정

    GET : 리소스 조회

    POST : 요청 내역 처리

-요청대상(/search?q=hello&hl=ko)

  absolute-path[?query](절대경로[?쿼리])

  절대경로="/"로 시작하는 경로 

-HTTP Version

  HTTP 버전을 넣는다.

응답 메시지

status-line = HTTP-version SP status-code SP reason-phrase CRLF

-HTTP 버전

-HTTP 상태 코드

  200 : 성공

  400 : 클라이언트 요청 오류

  500 : 서버 내부 오류

-이유 문구

 사람이 이해할 수 있는 짧은 상태 코드 설명 글

HTTP 헤더

header-field = field-name ":" OWS field-value OWS (OWS : 띄어쓰기 허용)

용도

HTTP 전송에 필요한 모든 부가정보가 들어가 있다.

예) 메시지 바디의 내용, 메시지 바디의 크기, 압축, 인증, 요청 클라이언트 정보, 서버 애플리케이션, 캐시 관리 정보...

표준 헤더가 너무 많음

필요시 임의의 헤더 추가 가능 

HTTP 메시지 바디

용도

실제 전송할 데이터

HTML문서, 이미지, 영상, JSON 등등 byte로 표현할 수 있는 모든 데이터 전송 가능

단순함 확장 가능 

HTTP는 단순하다. 

HTTP 메시지도 매우 단순

크게 성공하는 표준 기술은 단순하지만 확장 가능한 기술

TCP/IP 기본적으로 연결을 유지를 해야한다.

연결을 유지하는 모델

클라이언트 1 이 요청을 보내고 서버로 부터 응답을 받는다 그렇게 되면 연결이 유지된다.

클라이언트 2가 요청을 보내고 서버로 부터 응답을 받는다 이때 클라이언트 1은 연결은 유지된 상태이다.

클라이언트 3이 들어온다면 서버는 연결을 모두 유지해야할 필요가 생긴다.

연결을 유지하지 않는 모델  

클라이언트 1과 서버는 필요한 것만 주고 받고 연결을 끊는다.

클라이언트 2,3도 같다. 이렇게 되면 서버 입장에서 최소한의 자원만 사용할 수 있다.

비연결성

HTTP는 기본이 연결을 유지하지 않는 모델

일반적으로 초 단위의 이하의 빠른 속도로 응답

1시간 동안 수천명이 서비스를 사용해도 실제 서버에서 동시에 처리하는 요청은 수십개 이하로 매우 작다.

서버 자원을 매우 효율적으로 사용할 수 있다.

비연결성 한계와 극복

TCP/IP 연결을 새로 맺어야함 - 3 way handshake  시간 추가

웹 브라우저로 사이트를 요청하면 HTML 뿐만 아니라 자바스크립트, css, 추가 이미지 등 수많은 자원이 함께 다운로드

지금은 HTTP 지속 연결로 문제 해결

HTTP/2, HTTP/3에서 더 많은 최적화

스테이스리스를 기억하자 

정말 같은 시간에 딱 맞추어 발생하는 대용량 트래픽 

최대한 스테이스리스를 사용하는 것이 중요하다.