HTTP 메서드

1. HTTP API 만들기

 

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

API URI 고민
URI(Uniform Resource Identifier)

• 리소스의 의미
  • 회원을 등록 수정 조회하는 것이 리소스가 아닌, 회원이라는 개념 자체가 리소스
• 리소스 식별
  • 회원이라는 리소스만 식별 ▶︎ 회원 리소스를 URI 에 매핑

 

리소스와 행위를 분리
가장 중요한 것은 리소스를 식별하는 것

• URI는 리소스만 식별
• 리소스와 해당 리소스를 대상으로 하는 행위를 분리
  • 리소스 : 회원
  • 행위 : 조회, 등록, 삭제, 변경

---

2. HTTP 메서드 - GET, POST

 

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

 

• HEAD : GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
• OPTIONS : 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
  • CORS(Cross Origin Resource Sharing) : 클라이언트 애플리케이션과 다른 origin을 가진 서버 애플리케이션이 서로 통신할 수 있도록 허용하는 프로토콜.
    예를 들어, 클라이언트 애플리케이션이 www.mysite.com 으로 되어 있고, 서버 애플리케이션은 www.serverapi.com으로 올라와 있는 경우이다.
    클라이언트와 서버는 보안적 이유로 같은 origin을 가진 경우에만 서로 통신할 수 있다. (same origin policy)
    하지만 이 경우는 많지 않은데, 그 이유는 클라이언트의 크기가 커지면서 별도로 관리하기 위해 별도의 origin을 가지게 된다.
    그렇기에 서로 다른 origin에서 통신이 가능하게 하기 위해 CORS가 필요하다.
• CONNECT : 대상 자원으로 식별되는 서버에 대한 터널을 설정
• TRACE : 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트 수행 

 

1) GET 

• 리소스 조회
  • 서버로 메시지 전달 
  • 서버 도착
  • 클라이언트로 응답 데이터
• 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)을 통해 전달
• 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음

 

2) POST

• 요청 데이터 처리
• 메시지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
  • 메시지 전달
  • 신규 리소스 생성 (/members ▶︎ /members/100)
  • 응답 데이터
• POST는 요청 데이터를 어떻게 처리한다는 뜻일까?
  • POST 메서드는 대상 리소스가 리소스의 고유한 의미 체계에 따라 요청에 포함된 표현을 처리하도록 요청함
    • HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
      • HTML, FORM 에 입력한 정보로 회원 가입, 주문 등에서 사용
    • 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
      • 게시판 글쓰기, 댓글 달기
    • 서버가 아직 식별하지 않은 새 리소스 생성
      • 신규 주문 생성
    • 기존 자원에 데이터 추가 
      •  한 문서 끝에 내용 추가하기

 

3) POST 정리

 

(1) 새 리소스 생성(등록)

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

(2) 요청 데이터 처리 

• 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우 (주문 ▶︎ 결제 ▶︎ 배달시작 ▶︎ 배달 완료)
• POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음 (POST /orders/{orderId}/start-delivery (컨트롤 URI)

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

JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우 / 애매하면 POST

---

3. HTTP 메서드 - PUT, PATCH, DELETE

 

1) PUT

• 리소스를 대체
  • 리소스가 있으면 대체 (완전 대체됨! 주의)
  • 리소스가 없으면 생성
• 클라이언트가 리소스를 식별
  • 클라이언트가 리소스 위치를 알고 URI 지정
  • /members/100 ◀︎ 100이라는 위치를 지정
• name: a, age: 10 이라는 데이터를 name:b, age:50 이라는 데이터를 가지던 100에 보내면 100의 데이터는 name a 에 age 10 으로 변경됨
• name: c 라는 데이터를 name:d, age:30 의 데이터를 가진 100에 보내면 name:c로 완전 대체! age사라

 

2) PATCH (부분 변경)

3) DELETE (리소스 제거)

---

3. HTTP 메서드의 속성

 

• 안전(Safe Methods)
  • 호출해도 리소스를 변경하지 않는다.
• 멱등(Idempotent Methods) : 연산을 여러 번 적용하더라도 결과가 달라지지 않는 성질을 의미
  • 한 번 호출하던 두 번 호출하던 100번 호출하든 결과가 똑같다.
  • POST는 멱등이 아니다!! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다!
  • 멱등의 활용
    • 자동 복구 메커니즘
    • 서버가 timeout 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가?
  • 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
• 캐시가능(Cacheable Methods)
  • 응답 결과 리소스를 캐시해서 사용해도 되는가?
  • GET, HEAD, POST, PATCH 캐시 가능
  • 실제로는 GET, HEAD 정도만 캐시로 사용 
    • POST, PATCH 는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음