kingsubin

1. HTTP API 만들기

URL 설계에서 가장 중요한 건 리소스 식별 !

 

리소스의 의미가 뭘까 ?

회원을 등록하다 -> 여기서 회원이라는 개념 자체가 바로 리소스이다.

 

그럼 어떻게 식별하는 게 좋을까 ?

등록, 수정, 조회하는 것들은 모두 배제하고 "회원" 이라는 리소스만 식별하면 된다.

-> 회원 리소스를 URI 에 매핑

 

API URI 설계

회원 목록 조회 /members

회원 조회 /members/{id}

회원 등록 /members/{id}

회원 수정 /members/{id}

회원 삭제 /members/{id}

 

계층 구조상 상위 컬렉션으로 보고 복수 단어 사용 권장

ex) member -> members, comment -> comments

 

가장 중요한 건 URI 는 리소스만 식별하는 것이다.

리소스와 행위를 분리해야 한다.

 

그러면 조회, 등록, 수정, 삭제는 URI 가 같은데 어떻게 구분할까 ?

 

우리가 할 일은 URI 의 리소스만 식별하면 된다.

행위 구분은 HTTP 메서드로 대신할 수 있다.

 

HTTP 메서드 종류

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

 

 

잘 사용하지 않는 기타 메서드

• HEAD: GET 과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
• OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명 (주로 CORS 에서 사용) 
• CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정
• TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행

 

---

2. HTTP 메서드 - GET, POST

GET

• 리소스 조회
• 서버에 전달하고 싶은 데이터는 쿼리 파라미터를 통해 전달
• 메시지 바디를 사용해서 전달할 수 있지만, 권장하지 않는다.

 

POST

• 요청 데이터 처리
• 메시지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리
  • 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용

 

 

POST 의 사용 예시

• HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
  • HTML FORM 에 입력한 정보로 가입, 주문 등에 사용
• 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
  • 게시판 글쓰기, 댓글 달기
• 서버가 아직 식별하지 않은 새 리소스 생성
  • 신규 주문 생성
• 기존 자원에 데이터 추가
  • 한 문서 끝에 내용 추가하기

:: 리소스 URI 에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다. -> 정해진 게 없음

 

 

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

2. 요청 데이터 처리

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

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

  - ex) POST /orders/{orderId}/start-delivery (이러한 것을 컨트롤 URI 라고 함)

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

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

  - 애매하면 POST

 

---

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

PUT

• 리소스를 완전히 대체
• 있으면 대체 , 없으면 생성
• 비유하자면 폴더에 파일 넣는 것과 같이 덮어버림
• POST 와는 달리 클라이언트가 리소스 위치를 알고 URI 지정해야 함

 

PATCH

• 리소스 부분 변경
• PUT 이 완전히 덮어버렸다면 PATCH 의 경우는 필요한 부분만 변경할 수 있다.

 

DELETE

• 리소스 제거

 

---

4. HTTP 메서드의 속성

메서드마다 특징이 특징이 있기에 나눠놓았겠지?

 

 

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

 

안전 (Safe)

• 해당 리소스가 변하는가 안 변하는가?
• 안전은 해당 리소스만 고려한다.

 

멱등 (Idempotent)

• f(f(x)) = f(x)
• 한 번 호출하든 백 번 호출하든 결과가 같다.
• 멱등 메서드
  • GET : 한 번 조회하든, 두 번 조회하든 같은 결과
  • PUT : 결과를 대체, 따라서 같은 요청을 여러 번 해도 최종 결과는 같다.
  • DELETE : 결과를 삭제하기에 같은 요청을 여러번 해도 삭제된 결과는 같다.
  • POST : 멱등이 아니다. 여러 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
• 활용
  • 자동 복구 메커니즘
  • 서버가 TIMEOUT 등으로 정상 응답을 못 주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가? 의 판단 근거
• 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.

 

캐시가능 (Cacheable)

• 응답 결과 리소스를 캐시 해서 사용해도 되는가 ?
• GET, HEAD, POST, PATCH 가 가능하지만 실제로는 GET, HEAD 정도만 캐시로 사용한다.

 

 

 

 

---

※ 출처

www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC/dashboard