[HTTP] HTTP 메서드 활용(2)

🌳 HTTP API 설계 예시

HTTP API - 컬렉션

    ▪ POST 기반 등록 (ex. 회원 관리 API 제공)

HTTP API - 스토어

    ▪ PUT 기반 등록 (ex. 정적 컨텐츠 관리, 원격 파일 관리)

HTTP API - FORM 사용

    ▪ 웹 페이지 회원 관리 (GET, POST만 가능)

 

🍃 POST 기반 등록

API 설계 (회원 관리 시스템)

    ▪ 회원 목록 /members -> GET

    ▪ 회원 등록 /members -> POST

    ▪ 회원 조회 /members/{id} -> GET

    ▪ 회원 수정 /members/{id} -> PATCH, PUT, POST

    ▪ 회원 삭제 /members/{id} -> DELETE

 

POST 신규 자원 등록 특징

    ▪ 클라이언트는 등록될 리소스의 URI를 모른다.

    ▪ 서버가 새로 등록된 리소스 URI를 생성해준다. (ex. 응답 데이터에서 Location: /members/100)

    ▪ 컬렉션: 서버가 관리하는 리소스 디렉토리로, 서버가 리소스의 URI를 생성하고 관리한다.

      여기선 /members가 컬렉션

 

PUT vs PATCH

리소스를 수정할 때 PATCH를 사용해야 하는 경우와 PUT을 사용해야 하는 경우를 잘 따져야 함

회원정보 수정 같은 경우는 일부를 수정해야 하므로 PATCH를, 게시글 수정 같은 경우는 전부 다 다시 작성하는 것이므로 PUT을, 이것저것 애매할 때는 POST를 사용

 

🍃 PUT 기반 등록

API 설계 (파일 관리 시스템)

    ▪ 파일 목록 /files -> GET

    ▪ 파일 조회 /files/{filename} -> GET

    ▪ 파일 등록 /files/{filename} -> PUT

    ▪ 파일 삭제 /files/{filename} -> DELETE

    ▪ 파일 대량 등록 /files -> POST

 

새로 업로드할 파일 이름을 클라이언트가 알고 있음 & 파일은 기존 파일을 지우고 덮어쓸 수 있음 -> PUT 메서드

 

PUT 신규 자원 등록 특징

    ▪ 클라이언트는 등록될 리소스의 URI를 알고 있다. 

    ▪ 클라이언트가 직접 리소스의 URI를 지정한다.

    ▪ 스토어: 클라이언트가 관리하는 리소스 저장소로, 클라리언트가 리소스의 URI를 알고 관리한다. (여기선 /files가 스토어)

 

🍃 HTML FORM 사용

API 설계

    ▪ 회원 목록 /members -> GET

    ▪ 회원 등록 폼 /members/new -> GET

    ▪ 회원 등록 /members/new, members -> POST    //등록 폼과 URL을 맞추는 것을 추천

    ▪ 회원 조회 /members/{id} -> GET

    ▪ 회원 수정 폼 /members/{id}/edit -> GET

    ▪ 회원 수정 /members/{id}/edit, /members/{id} -> POST  //수정 폼과 URL을 맞추는 것을 추천

    ▪ 회원 삭제 /members/{id}/delete -> POST (컨트롤 URI)

 

컨트롤 URI

    ▪ GET, POST만 지원하므로 제약이 존재, 이를 해결하기 위해 동사로 된 리소스 경로 사용

    ▪ POST의 /new, /edit, /delete가 컨트롤 URI

    ▪ HTTP 메서드로 해결하기 애매한 경우 사용 (HTTP API 포함) -> 최대한 지양

---

참고자료

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

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