Stateful, Stateless 특징
Stateful
상태를 유지한다.
로그인 세션 등, 상태를 유지해야 하는 경우에 사용한다.
Stateless
상태를 유지하지 않는다.
확장에 유리하다.
HTTP API 설계
API URI 설계 규칙
- 최대한 리소스를 기준으로 설계하자.
- 리소스(명사)와 해당 리소스를 대상으로 하는 행위(동사)를 분리하자.
- 행위는 HTTP 메서드로 구분하자.
위의 규칙은 이상적인 설계 규칙이고, 필수적으로 지켜야 하는 것은 아님.
GET: 리소스 조회
주로 쿼리 파라미터를 통해 서버로 요청 데이터 전달
주로 조회에 사용한다. GET으로 조회하면 데이터를 캐싱해둬서 조회에 유리함.
POST: 요청 데이터 처리, 주로 등록에 사용
메시지 바디를 통해 서버로 요청 데이터 전달
주로 신규 리소스 등록, 프로세스 처리에 사용한다.
서버가 컬렉션(리소스 저장소)을 관리한다.
PUT: 리소스를 대체, 해당 리소스가 없으면 생성
덮어쓰기라고 생각하자.
클라이언트가 리소스를 식별한다 -> 클라이언트가 리소스 위치를 알고 URI를 지정한다.
리소스를 완전히 대체하므로 리소스 부분 수정이 아닌 대체의 의도로 사용한다.
클라이언트가 스토어(리소스 저장소)를 관리한다.
PATCH: 리소스 부분 변경
수정할 때 쓴다고 생각하자.
PATCH를 사용할 수 없다면 POST로 사용하자.
DELETE: 리소스 삭제
리소스 제거에 사용한다.
HTTP 메서드의 속성
안전
호출해도 리소스를 변경하지 않는다. GET, HEAD 등등
멱등
한 번 호출하든 두 번 호출하든 결과가 똑같다.
GET, PUT, DELETE는 멱등이다.
POST는 멱등이 아니다.
어디에 활용할까? -> 자동 복구 메커니즘, 타임아웃 요청을 다시 요청해도 될까?
캐시가능
응답 결과 리소스를 캐시해서 사용해도 되는가?
GET, HEAD, POST, PATCH 캐시 가능
실제로는 GET, HEAD 정도만 캐시로 사용
왜? POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 어려움.
데이터 전송
HTML Form 데이터 전송
GET, POST 모두 가능
Content-Type: application/x-www.form-urlencoded: 메시지 바디를 통해 데이터를 url encoding 하여 전송
Content-Type: multipart/form-data: 다른 종류의 여러 파일과 폼의 내용 전송 가능
HTML API 데이터 전송
Request를 만들어서 전송하면 됨
GET: 조회에 사용, 쿼리 파라미터로 데이터 전달
POST, PUT, PATCH: 메시지 바디를 통해 데이터 전달
Content-Type: application/json을 주로 사용 (사실상 표준)
HTTP 상태 코드
1xx: 요청이 수신되어 처리중 (거의 안 씀)
2xx: 요청 정상 처리
200 OK: 요청 성공
201 Created: 요청 성공해서 새로운 리소스가 생성됨 (생성된 리소스는 응답의 Location 헤더 필드로 식별)
202 Accepted: 요청이 접수되었으나 처리가 완료되지 않았음. 배치 처리 같은 곳에서 사용(요청 1시간 뒤에 요청을 처리)
204 No Content: 서버가 요청을 성공적으로 수행했지만, 응답 페이로드 본문에 보낼 데이터가 없음 (저장 버튼을 눌러도 같은 화면을 유지해야 함)
3xx: 요청을 완료하려면 추가 행동이 필요
특징: 웹 브라우저는 3XX 응답의 결과에 Location 헤더가 있으면, Location 위치로 리다이렉션
300 Multiple Choices: 거의 안 씀
영구 리다이렉션 301 308
301 Moved Permanently: 리다이렉트시 요청 메서드가 GET으로 변하고, 본문이 제거될 수 있음
308 Permanent Redirect: 리다이렉트시 요청 메서드와 본문을 유지함.
일시적 리다이렉션 302 303 307
302 Found: 리다이렉트시 요청 메서드가 GET으로 변할 수 있음, 본문이 제거될 수 있음
303 See Other: 302와 기능은 같지만, 리다이렉트시 요청 메서드가 GET으로 변경
307 Temporary Redirect: 302와 기능은 같지만, 리다이렉트시 요청 메서드와 본문을 유지함
사용 예시: PRG(POST/REDIRECTION/GET)
- POST로 주문 후에 새로 고침으로 인한 중복 주문 방지
- POST로 주문 후에 주문 결과 화면을 GET 메서드로 리다이렉트
- 새로고침을 해도 결과 화면을 GET으로 조회
- 중복 주문 대신에 결과 화면만 GET으로 다시 요청
이런 방식으로 중복 주문 문제 해결
기타 리다이렉션 300 304
300 Multiple Choices: 안 쓴다
304 Not Modified: 캐시를 목적으로 사용. 클라이언트에게 리소스가 수정되지 않았음을 알려준다. 304 응답은 메시지 바디를 포함하면 안 된다. 조건부 GET, HEAD 요청시 사용한다.
4xx: 클라이언트 오류, 잘못된 문법 등으로 서버가 요청을 수행할 수 없음
인증(Authentication): 본인이 누구인지 확인(로그인)
인가(Authorization): 권한 부여(ADMIN, USER) 등 특정 리소스에 접근할 수 있는 권한
400 Bad Request: 클라이언트가 잘못된 요청을 해서 서버가 요청을 처리할 수 없음. 요청 구문, 메시지 오류 등.. 요청 파라미터가 잘못되거나, API 스펙이 맞지 않을 때 발생함
401 Unauthorized: 클라이언트가 해당 리소스에 대한 인증이 필요함. 오류 발생시 응답에 WWW-Authenticate 헤더와 함께 인증 방법을 설명하자
403 Forbidden: 서버가 요청을 이해했지만 승인을 거부함. 주로 인증은 했지만 접근 권한이 불충분한 경우에 사용함
404 Not Found: 요청 리소스를 찾을 수 없음. 요청 리소스가 서버에 없거나 클라이언트가 권한이 부족한 리소스에 접근하면 해당 리소스를 숨기고 싶을 때 사용함
5xx: 서버 오류, 서버가 정상 요청을 처리하지 못함
500 Internal Server Error: 서버 문제로 오류 발생, 애매하면 500 오류로 사용함.
503 Service Unavailable: 서비스 이용 불가. 서버가 일시적인 과부하 또는 예정된 작업으로 잠시 요청을 처리할 수 없을 때 사용함. Retry-After 헤더 필드로 복구 예상 시간을 보낼 수도 있음.
HTTP Header
용도: HTTP 전송에 필요한 모든 부가 정보를 가진다.
RFC2616(과거)
General 헤더: 메시지 전체에 적용되는 정보
Request 헤더: 요청 정보
Response 헤더: 응답 정보
Entity 헤더: 엔티티 바디 정보
RFC7230(최근)
엔티티 -> 표현으로 변경
메시지 본문(페이로드)을 통해 표현 데이터 전달
표현은 요청이나 응답에서 전달할 실제 데이터
표현 헤더는 표현 데이터를 해석할 수 있는 정보 제공
표현
Content-Type: 표현 데이터의 형식 (text/html;charset=UTF-8)
Content-Encoding: 표현 데이터의 압축 방식 (gzip)
Content-Language: 표현 데이터의 자연 언어 (ko)
Content-Length: 표현 데이터의 길이 (1234)
표현 헤더는 전송, 응답 둘 다 사용
협상
클라이언트가 선호하는 표현 요청
Accept: 클라이언트가 선호하는 미디어 타입 전달
Accept-Charset: 클라이언트가 선호하는 문자 인코딩
Accept-Encoding: 클라이언트가 선호하는 압축 인코딩
Accept-Language: 클라이언트가 선호하는 자연 언어
협상 헤더는 요청시에만 사용. 원하는 옵션대로 요청한다고 생각하자.
협상 우선순위
Quality Value 값 사용, 생략하면 1
예시) Accept-Language: ko-KR,ko;q=0.9,en-US;q=0.8,en;q=0.7
구체적인 것을 우선한다.
Accept: text/*, text/plain, text/plain;format=flowed, / 인 경우, 가장 구체적인 것부터 우선순위가 높음.
구체적인 것을 기준으로 미디어 타입을 맞춘다.
위와 같이 구체적인 것을 기준으로 맞춘다.
전송 방식
단순 전송
Content-Length
데이터를 그냥 보낸다.
압축 전송
Content-Encoding
데이터를 압축해서 보낸다.
분할 전송
Transfer-Encoding: chunked
데이터를 분할해서 보낸다. 분할하므로 Content-Length는 넣지 않는다.
범위 전송
데이터의 범위를 지정해서 보낸다.
일반 정보
From: 유저 에이전트의 이메일 정보
Referer: 현재 요청된 페이지의 이전 웹 페이지 주소. 요청에서 사용. 이걸로 유입 경로 분석 가능.
User-Agent: 유저 에이전트 애플리케이션 정보. 어떤 종류의 브라우저에서 장애가 발생하는지 파악 가능. 요청에서 사용.
Server: 요청을 처리하는 ORIGIN 서버의 소프트웨어 정보. 응답에서 사용
Date: 메시지가 발생한 날짜와 시간. 응답에서 사용
특별한 정보
Host: 요청한 호스트 정보(도메인)
요청에서 사용함.
필수 헤더임.
하나의 서버가 여러 도메인을 처리해야 할 때 사용함.
하나의 IP 주소에 여러 도메인이 적용되어 있을 때 사용함.
Location: 페이지 리다이렉션
웹 브라우저는 3xx 응답의 결과에 Location 헤더가 있으면, Location 위치로 자동 이동.
Allow: 허용 가능한 HTTP 메서드
405 (Method Not Allowed)에서 응답에 포함해야함
Allow: GET, HEAD, PUT
Retry-After: 유저 에이전트가 다음 요청을 하기까지 기다려야 하는 시간
503(Service Unavailable) 서비스가 언제까지 불능인지 알려줄 수 있음
인증
Authorization: 클라이언트 인증 정보를 서버에 전달
WWW-Authenticate: 리소스 접근시 필요한 인증 방법 정의
401 Unauthorized 응답과 함께 사용
쿠키
사용처
- 사용자 로그인 세션 관리
- 광고 정보 트래킹
쿠키 정보는 항상 서버에 전송됨
- 네트워크 트래픽 추가 유발
- 최소한의 정보만 사용(세션 id, 인증 토큰)
- 서버에 전송하지 않고, 웹 브라우저 내부에 데이터를 저장하고 싶으면 웹 스토리지 참고
보안에 민감한 데이터는 저장하면 안됨
Set-Cookie: 서버에서 클라이언트로 쿠키 전달(응답)
Expires
만료일이 되면 쿠키 삭제
세션 쿠키: 만료 날짜를 생략하면 브라우저 종료때까지만 유지
영속 쿠키: 만료 날짜를 입력하면 해당 날짜까지 유지
Domain
domain=example.org를 지정해서 쿠키 생성하면 명시한 문서 기준 도메인 + 서브 도메인 포함해서 전송
example.org에서 쿠키르 생성하고 domain 지정을 생략하면 example.org 에서만 쿠키 접근
dev.example.org 에서는 접근 불가
Path
예) path=/home
위 경로를 포함한 하위 경로 페이지만 쿠키 접근 가능
Secure, HttpOnly, SameSite
Secure
쿠키는 http, https 구분하지 않고 전송하는데, Secure 적용하면 https인 경우에만 전송
HttpOnly
XSS 공격 방지, 자바스크립트에서 접근 불가(document.cookie), HTTP 전송에만 사용
SameSite
XSRF 공격 방지, 요청 도메인과 쿠키에 설정된 도메인이 같은 경우에만 쿠키 전송
Cookie: 클라이언트가 서버에서 받은 쿠키를 저장하고, HTTP 요청시 서버로 전달
캐시
캐시 컨트롤 헤더를 cache-control: max-age=60 이렇게 설정하면 브라우저 캐시에 60초 동안 응답 결과를 저장함
캐시 시간 초과되면 다시 요청해서 갱신함
근데 서버에서 기존 데이터를 변경하지 않았다면 다시 요청하는건 낭비임
Last-Modified, If-Modified-Since
그러므로 Last-Modified 헤더를 설정해서 데이터 최종 수정일을 클라이언트한테 알려준다. 그러면 갱신 요청을 할 때, if-modified-since 헤더를 설정하면 수정일을 비교해서 수정되지 않았다면 304 Not Modified로 응답한다. 이때 Last-Modified 헤더를 설정해야하고, HTTP Body가 없다.
응답을 받은 브라우저는 캐시를 갱신하여 사용한다.
정리
- 캐시 유효 시간이 초과해도, 서버의 데이터가 갱신되지 않으면
- 304 Not Modified + 헤더 메타 정보만 응답(Body 없음)
- 클라이언트는 서버가 보낸 응답 헤더 정보로 캐시의 메타 정보를 갱신
- 클라이언트는 캐시에 저장되어 있는 데이터 재활용
- 결과적으로 네트워크 다운로드가 발생하지만, 용량이 적은 헤더 정보만 다운로드
단점
- 1초 미만 단위로 캐시 조정 불가능
- 날짜 기반의 로직 사용
- 데이터를 수정해서 날짜가 다르지만, 최종적으로 같은 데이터로 수정해서 데이터 결과가 같은 경우
- 서버에서 별도로 캐시 로직을 관리하고 싶은 경우
ETag, If-None-Match
- ETag(Entity Tag)
- 캐시용 데이터에 임의의 고유한 버전 이름을 달아둠
- 데이터가 변경되면 이 이름을 바꾸어서 변경함(Hash 다시 생성)
- 진짜 단순하게 ETag만 보내서 같으면 유지, 다르면 갱신하기
정리
- 캐시 제어 로직을 서버에서 완전히 관리
- 클라이언트는 단순히 이 값을 서버에 제공
Cache-Control
Cache-Control: max-age 캐시 유효 시간, 초 단위
Cache-Control: no-cache 데이터는 캐시해도 되지만, 항상 origin 서버에 검증하고 사용
Cache-Control: no-store 데이터에 민감한 정보가 있으므로 저장하면 안됨
하위 호환으로 pragma, expires 헤더가 있음. 그러나 캐시컨트롤 사용 권장
프록시 캐시
public 캐시: 공용으로 사용하는 캐시 서버
private 캐시: 개인이 사용하는 캐시 서버
Cache-Control: public 공용 서버에 저장해도 됨
Cache-Control: private 공용 서버에 저장하면 안됨 (default)
캐시 무효화
캐시를 사용하지 말아야 하는 경우 아래 헤더들 포함해주자.
Cache-Control: no-cache
데이터는 캐시해도 되지만, 항상 원 서버에 검증하고 사용
Cache-Control: no-store
데이터에 민감한 정보가 있으므로 저장하면 안됨
Cache-Control: must-revalidate
캐시 만료 후 최초 조회시 원 서버에 검증해야함
원 서버 접근 실패시 반드시 오류가 발생해야함 - 504(Gateway Timeout)
must-revalidate는 캐시 유효 시간이라면 캐시를 사용함
Pragma: no-cache
HTTP1.0 하위호환을 위해 설정
