[HTTP] API URI 설계와 HTTP 메서드

📌 API URI 설계

✅ API URI 설계 예시

요구사항 : 회원 정보 관리 API를 만들어라.

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

→ 좋은 URI 설계일까?

 

✅ 리소스와 행위를 분리

• 먼저 리소스를 식별하는 것이 가장 중요하다.
• 리소스는 명사, 행위는 동사
• 회원이라는 개념 자체가 리소스이며 등록하고, 수정하고, 조회하는 것은 모두 배제한다.

 

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

• 회원 목록 조회 /members 
• 회원 조회 /members/{id} 
• 회원 등록 /members/{id} 
• 회원 수정 /members/{id} 
• 회원 삭제 /members/{id}

계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장 (e.g. member -> members)

 

URI를 리소스를 식별해서 잘 설계했으나 행위를 구분할 필요가 있음 → HTTP 메서드 활용

 

📌 HTTP 주요 메서드 종류

✅ GET

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

 

✅ POST

• 메세지 바디를 통해 서버로 요청 데이터 전달
• 서버는 요청 데이터를 처리
• 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
• 신규 리소스를 요청하는 경우 응답 메세지에 201 Created 코드를 사용하면 리소스가 생성된 경로를 보내줌
• 클라이언트는 리소스의 URI 주소를 모르고 요청이 발생하면 서버에서 URI를 지정해줌

 

🔻 요청 데이터 처리 예시 (서버에 변화 발생)

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

POST는 행위가 따로 정해진 것이 없으므로 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 한다.

 

✅ PUT

• 리소스가 존재하면 완전히 대체, 없으면 생성
• 클라이언트가 리소스 위치를 알고 URI를 지정함 (POST와의 차이)
• 리소스를 완전히 대체하기 때문에 서버에 저장된 리소스 필드에 손실이 발생할 수 있음

 

✅ Patch

• PUT과 달리 리소스의 필드를 부분적으로 변경

 

✅ Delete

• 지정한 위치의 리소스 제거

 

📌 HTTP 메서드 속성

✅ 안전(Safe Methods)

• 호출해도 리소스를 변경하지 않는다.
• GET, HEAD는 안전한 메서드, 값을 변경하는 메서드인 POST, PUT, DELETE는 안전한 메서드가 아님 

 

✅ 멱등(Idempotent Methods)

• 몇 번 호출하든 결과가 똑같다.
• 멱등 메서드
  • GET : 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
  • PUT : 결과를 대체한다. 따라서 같은 요청을 여러 번 해도 최종 결과는 같다.
  • DELETE : 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 같다.
• POST는 멱등이 아님, 두번 호출하면 같은 결제가 중복해서 발생할 수 있다.
• 활용 > 클라이언트가 같은 요청을 다시 해도 되는가? 판단 기준, 자동 복구 매커니즘

 

✅ 캐시 가능(Cacheable Methods)

• 응답 결과 리소스를 캐시해서 사용할 수 있는 메서드
• GET, HEAD, POST, PATCH 캐시 가능
• 실제로는 GET, HEAD 정도만 사용, POST, PATCH는 구현이 쉽지 않음

 

---

강의 자료

모든 개발자를 위한 HTTP 웹 기본 지식 - 인프런 | 강의