💫 HTTP API 설계 예시

HTTP API 설계 예시 중 아래 3가지 예시에 대해서 알아보겠습니다.

1. HTTP API - 컬렉션

• POST 기반 등록
• 예) 회원관리 API 제공

2. HTTP API - 스토어

• PUT 기반 등록
• 예) 정적 컨텐츠 관리, 원격 파일 관리

3. HTML FORM 사용

• 웹 페이지 회원 관리
• GET, POST만 지원

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

🐌 POST 기반 등록

• 회원 목록 /members -> GET
• 회원 등록 /members -> POST 👉 회원을 등록한다.
• 회원 조회 /members/{id} -> GET 👉 회원 하나를 조회한다.
• 회원 수정 /members/{id} -> PATCH, PUT, POST 👉 수정할땐 PATCH, 대체는 PUT(완전히 덮을때! 게시판에 게시글 수정할 때 사용), 이것도 저것도 애매한 경우 천하무적 POST 사용하기.
• 회원 삭제 /members/{id} -> DELETE 👉 원하는 회원 번호를 쓰고 DELETE를 한다.

항상 리소스를 식별해야한다. 예) 미네랄을 캐라 -> '미네랄'이 리소스임!

POST - 신규자원 등록 특징

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

- 회원 등록 /memebers -> POST
- POST /members

- 서버가 새로 등록된 리소스 URI를 생성해준다

- HTTP/1.1 201 Created
- Location: /members/100

- 컬렉션

- 서버가 관리하는 리소스 디렉토리
- 서버가 리소스의 URI를 생성하고 관리
- 여기서 컬렉션은 /members

---

🐌 PUT 기반 등록

• 파일 목록 /files -> GET
• 파일 조회 files/{filename} -> GET
• 파일 등록 files/{filename} -> PUT
• 파일 삭제 /files/{filename} -> DELETE
• 파일 대량 등록 /files -> POST

PUT - 신규 자원 등록 특징

- 클라이언트가 리소스 URI를 알고 있어야 한다.

- 파일 등록 /files/{filename} -> PUT
- PUT **/files/star.jpg**

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

- 스토어(Store)

- 클라이언트가 관리하는 리소스 저장소
- 클라이언트가 리소스의 URI를 알고 관리
- 여기서 스토어는 /files

POST같은 경우에는 리소스의 URI를 몰라서 /members/만 넘겨주면 알아서 {100}이라는 회원번호 숫자가 붙는다. 근데 PUT은 본인이 알고 URI를 지정한다.
하지만 대부분은 실무에서는 POST 기반의 컬렉션들을 많이 사용한다.

---

🐌 HTML FORM 사용

• HTML FORM은 GET,POST만 지원한다.

• AJAX 같은 기술을 사용해서 해결 가능하다 -> 회원 API 참고

• 컨트롤 URI
  - GET, POST만 지원하므로 제약이 있다.

  • 이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
  • POST의 /new, /edit, /delete가 컨트롤 URI
  • HTTP 메서드로 해결하기 애매한 경우 사용 (HTTP API 포함)

• 회원 목록 /members -> GET

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

• 회원 등록 /members/new, /members -> POST

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

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

• 회원 수정 /members/{id}/edit, /members/{id} -> POST

• 회원 삭제 /members/{id}/delete -> POST

---

🐌 참고하면 좋은 URI 설계 개념

1. 문서

• 단일 개념 (파일 하나, 객체 인스턴스, 데이터베이스 ROW)
• 예) members/100, /files/star.jpg

2. 컬렉션 (대부분 컬렉션을 사용한다)

• 서버가 관리하는 리소스 디렉터리
• 서버가 리소스의 URI를 생성하고 관리한다
• 예) /members

3. 스토어 (store) (게시판 같은 경우 스토어도 종종 사용한다)

• 클라이언트가 관리하는 자원 저장소
• 클라이언트가 리소스의 URI를 알고 관리
  예) /files

4. 컨트롤러, 컨트롤 URI

• 문서, 컬렉션, 스토어로 해결하기 어려운 추가 프로세스 실행
• 동사를 직접 사용
• 예) /members/{id}/delete