[모든 개발자를 위한 HTTP 웹 기본 지식] 8.HTTP 메서드 활용( 2/2 )

HTTP API 설계 예시

1. HTTP API - 컬렉션
   • POST 기반 등록
   • ex. 회원 관리 API 제공
   • 서버가 리소스 URI 결정
2. HTTP API - 스토어
   • PUT 기반 등록
   • ex. 정적 컨텐츠 관리, 원격 파일 관리
   • 클라이언트가 리소스 URI 결정
3. HTTP FORM 사용
   • 웹 페이지 회원 관리
   • GET, POST만 지원( 순수 HTML + HTML form 사용 )

---

1. HTTP API - 컬렉션

회원 관리 시스템 설계

- API 설계 - POST 기반 등록

※ 리소스를 식별해야한다. 행위로 식별하면 안된다.

• 회원 목록 /members -> GET
• 회원 등록 /members -> POST
• 회원 조회 /members/{id} -> GET
• 회원 수정 /members/{id} -> PATCH, PUT, POST
• 회원 삭제 /members/{id} -> DELETE

- POST - 신규 자원 등록 특징

※ 서버가 '/members' URI로 넘어온 데이터로 등록한 후에, 리소스 URI를 만들어 준다.( member의 키 매핑 )

• 클라이언트는 등록될 리소스의 URI를 모른다.
  • 회원 등록 /members -> POST
  • POST /members
• 서버가 새로 등록된 리소스 URI를 생성해준다.
  • HTTP/1.1 201 Created
    Location : /members/100
• 컬렉션( Collection )
  • 서버가 관리하는 리소스 디렉토리
  • 서버가 리소스의 URI를 생성하고 관리
  • 여기서 컬렉션은 /members

---

2. HTTP API - 스토어

파일 관리 시스템 설계

- API 설계 - PUT기반 등록

• 파일 목록 /files -> GET
• 파일 조회 /files/{filename} -> GET
• 파일 등록 /files/{filename} -> PUT
  • 기존 파일을 지우고 재등록을 해서 PUT이다.
• 파일 삭제 /files/{filename}-> DELETE
• 파일 대량 등록 /files -> POST

- PUT- 신규 자원 등록 특징

• 클라이언트가 리소스의 URI를 알고 있어야 한다.
  • 파일 등록 /files/{filename} -> PUT
  • PUT /files/etoos.jpg
• 클라이언트가 직접 리소스의 URI를 지정한다.
• 스토어( Store )
  • 클라이언트가 관리하는 리소스 저장소
  • 클라이언트가 리소스의 URI를 알고 관리
  • 여기서 스토어는 /files

---

3 HTTP FORM

• HTML FORM은 GET, POST만 지원
• AJAX 같은 기술을 사용해서 해결 가능 -> 회원 API 참고
• 여기서는 순수 HTML, HTML FORM 로 진행
• GET, POST만 지원하므로 제약이 있음
• 컨트롤 URI
  • GET, POST만 지원하는 제약을 해결하기 위해 동사로 된 리소스 경로 사용
  • POST의 /new, /edit, /delete가 컨트롤 URI
  • HTTP 메서드로 해결하기 애매한 경우 사용( HTTP API 포함 )

HTML FORM 사용

• 회원 목록 /members -> GET
• 회원 등록 폼 /members/new -> GET
• 회원 등록 /members/new, /members -> POST
  • 두개의 URI 중에 마음에 드는 것을 사용하면 된다.
  • 그러나 '/members/new'를 추천한다.
    • '회원 등록 폼'과 맞춰주면 벨리데이션 체크를 할 때 별도 작업이 필요 없다.
    • 각 등록 폼과 uri과 맞추지 않을 경우 리턴되는 페이지에 대한 작업을 별도로 해줘야 한다.
• 회원 조회 /members/{id} -> GET
• 회원 수정 폼 /members/{id}/edit -> GET
• 회원 수정 /members/{id}/edit, /members/{id} -> POST
• 회원 삭제 /members/{id}/delete -> POST

---

참조하면 좋은 URI 설계 개념 예시

• 문서(document)
  • 단일 개념(파일 하나, 객체 인스턴스, 데이터베이스 row)
  • ex. /members/100, /files/star.jpg
• 컬렉션(collection)
  • 서버가 관리하는 리소스 디렉터리
  • 서버가 리소스의 URI를 생성하고 관리
  • ex. /members • 스토어(store)
• 클라이언트가 관리하는 자원 저장소
  • 클라이언트가 리소스의 URI를 알고 관리
  • ex. /files
• 컨트롤러(controller), 컨트롤 URI
  • 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
  • 동사를 직접 사용
  • ex. /members/{id}/delete

 

출처

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

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