tommy Note

[HTTP] HTTP API 설계

Alt Text

HTTP API 설계

예시

  • HTTP API (컬렉션)
    • POST 기반 등록
    • 회원관리 API 제공
  • HTTP API 스토어
    • PUT 기반 등록
    • 정적 컨텐츠 관리, 원격 파일 관리
  • HTML form 사용
    • 웹 페이지 회원 관리
    • GET, POST만 지원

회원관리 시스템 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
  • 컬렉션(Collection)
    • 서버가 관리하는 리소스 디렉토리
    • 서버가 리소스의 URI를 생성하고 관리
    • 여기서 컬렉션은 /members

PUT 기반 등록

  • 파일 목록 /files -> GET
  • 파일 조회 /files/{filename} -> GET
  • 파일 등록 /files/{filename} -> PUT
  • 파일 삭제 /files/{filename} -> Delete
  • 파일 대량 등록 /files -> POST

파일관리시스템 PUT 신규 자원 등록 특징

  • 클라이언트가 리소스 URI를 알고 있어야한다.
    • 파일 등록 /files/{filename} -> PUT
    • PUT /files/star.jpg
  • 클라이언트가 직접 리소스의 URI를 지정한다.
  • 스토어
    • 클라이언트가 관리하는 리소스 저장소
    • 클라이언트가 리소스의 URI를 알고 관리
    • 여기서 스토어는 /files

HTML FORM 사용

  • HTML form은 GET, POST만 지원
  • 컨트롤 URI
    • 제약이 있으므로, 동사로 된 리소스 경로 사용
    • POST의 /new. /edit, /delete가 컨트롤 URI
    • HTTP 메서드로 해결하기 애매한 경우 사용(HTTP API 포함)
  • 회원 목록 : /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 설계 개념

  • 문서
    • 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
    • /members/100, /files/star.jpg
  • 컬렉션
    • 서버가 관리하는 리소스 디렉터리
    • 서버가 리소스의 URI를 생성하고 관리
    • /members
  • 스토어
    • 클라이언트가 관리하는 자원 저장소
    • 클라이언트가 리소스의 URI을 지정하여 관리
    • /files
  • 컨트롤러, 컨트롤URI
    • 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
    • 동사를 직접 사용
    • /members/{id}/delete
  • 참조 : https://restfulapi.net/resource-naming

상태코드

  • 클라이언트가 보낸 요청의 처리 상태를 응답에서 알려주는 기능
    1. 1xx (informational) : 요청이 수신되어 처리중
    2. 2xx (Successful) : 요청 정상처리
    3. 3xx (Redirection) : 요청을 완료하려면 추가 행동이 필요
    4. 4xx (Client Error) : 클라이언트 오류, 잘못된 문법으로 서버가 요청을 수행할 수 없음
    5. 4xx (Server Error) : 서버 오류, 서버가 정상 요청을 처리하지 못함.

HTTP 헤더

  • HTTP 전송에 필요한 모든 부가정보

HTTP BODY

표현헤더 HTTP/1.1 200 OK Content-type: text/html;charset=UTF-8 Content-Length: 3423

표현 데이터 ##<html> ##<body> .. </body> ##<html>

  • 메시지 본문을 통해 표현 데이터 전달
  • 메시지 본문 = 페이로드(payload)
  • 표현은 요청이나 응답에서 전달할 실제 데이터
  • 표현 헤더는 표현 데이터를 해석할 수 있는 정보제공
    • 데이터 유형(html, json), 데이터길이, 압축 정보
  • 표현 헤더는 표현 메타데이터와, 페이로드 메시지를 구분

쿠키

  • Set-Cookie : 서버에서 클라이언트로 쿠키 전달(응답)
  • Cookie: 클라이언트가 서버에서 받은 쿠키를 저장하고, HTTP 요청시 서버로 전달
  • 사용처 : 사용자 로그인 세션관리, 광고 정보 트래킹
  • 쿠키정보는 항상 서버에 전송됌
    • 네트워크 트래픽 추가 유발
    • 최소한의 정보만 사용(세션 ID, 인증 토큰)
    • 서버에 전송하지 안고, 웹 프라우저 내부에 저장하고 싶다면 웹 스토리지 참고

Stateless

  • HTTP는 무상태 프로토콜
  • 클라이언트와 서버가 요청과 응답을 주고 받으면 연결이 끊어짐
  • 클라이언트가 다시 요청하면 서버는 이전 요청을 기억하지 못함

  • 클라이언트와 서버는 서로 상태를 유지하지 않음

  • 참조 : 김영한님의 HTTP웹 강의를 참조하였습니다. https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC

Categories:

Updated:

Leave a comment

You may also enjoy