CS | 네트워크 - HTTP 메서드

sik2·2022년 8월 27일
0

CS

목록 보기
4/8

HTTP API를 만들어보자

회원 정보 관리 API를 만든다고 가정하자

  • 회원 목록 조회
  • 회원 조회
  • 회원 등록
  • 회원 수정
  • 회원 삭제

API URI 설계 예

URI(Uniform Resource Identifier)

회원 목록 조회 /read-member-list 
회원 조회 /read-member-by-id 
회원 등록 /create-member
회원 수정 /update-member
회원 삭제 /delete-member

=> 해당 API URI 설계는 좋지 못하다

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

API URI 설계

리소스 식별, URI 계층 구조 활용

  • 회원이라는 개념 자체가 바로 리소스다.
  • 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑
회원 목록 조회 /members
회원 조회 /members/{id}
회원 등록 /members/{id}
회원 수정 /members/{id}
회원 삭제 /members/{id}
참고: 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장(member -> members)

리소스와 행위(메서드)을 분리

  • 가장 중요한 것은 리소스를 식별하는 것
  • URI는 리소스만 식별!
    • 리소스와 해당 리소스를 대상으로 하는 행위을 분리
    • 리소스: 회원
  • 행위: 조회, 등록, 삭제, 변경
  • 리소스는 명사, 행위(메서드)는 동사

HTTP 메서드 종류

  • GET: 리소스 조회
  • POST: 요청 데이터 처리, 주로 등록에 사용
  • PUT: 리소스를 대체, 해당 리소스가 없으면 생성
  • PATCH: 리소스 부분 변경
  • DELETE: 리소스 삭제

HTTP 메서드 - GET, POST

GET

예시
GET /search?q=hello&hl=ko HTTP/1.1 Host: www.google.com
  • 리소스 조회
  • 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달

POST

예시
POST /members HTTP/1.1 Content-Type: application/json
{
"username": "hello", "age": 20
}
  • 요청 데이터 처리
  • 메시지 바디를 통해 서버로 요청 데이터 전달
  • 서버는 요청 데이터를 처리

HTTP 메서드 - PUT, PATCH, DELETE

PUT

예시
PUT /members/100 HTTP/1.1 Content-Type: application/json
{
"username": "hello", "age": 20
}
  • 리소스를 대체
  • 리소스가 있으면 대체 리소스가 없으면 생성
  • 쉽게 이야기해서 덮어버림

PATCH

예시
PATCH /members/100 HTTP/1.1 Content-Type: application/json
{
"age": 50
}
  • 리소스 부분 변경

DELETE

예시
DELETE /members/100 HTTP/1.1 Host: localhost:8080
  • 리소스 제거

HTTP 메서드의 속성

  • 안전(Safe Methods)
  • 멱등(Idempotent Methods)
  • 캐시가능(Cacheable Methods)
profile
기록

0개의 댓글