HTTP - API 설계

URI는 항상 리소스 식별이 먼저다.

• 회원 목록 /members -> GET
• 회원 등록 /members -> POST
• 회원 조회 /members/{id} -> GET
• 회원 수정 /members/{id} -> PATCH, PUT, POST
  • 게시판 게시글 수정 시에는 PUT 사용(전체 덮어쓰여도 될때)
  • 그 외에는 PATCH를 많이 사용한다
• 회원 삭제 /members/{id} -> DELETE

HTTP API - 컬렉션(Collection)

POST 기반 등록

• 회원 관리 API 제공
• POST로 등록 시에는 서버에서 URI를 결정하고 만들어준다.
• 클라이언트는 등록될 리소스의 URI를 모른다.
  • 회원 등록 /members -> POST
  • POST /members
• 서버가 새로 등록된 리소스 URI를 생성해준다.
  • HTTP/1.1 201 Created
    Location: /members/100

이런 형식을 컬렉션(Collection)이라고 한다.

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

HTTP API - 스토어(Store)

PUT 기반 등록

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

• 파일 목록 /files -> GET
• 파일 조회 /files/{filename} -> GET
• 파일 등록 /files/{filename} -> PUT
• 파일 삭제 /files/{filename} -> DELETE
• 파일 대량 등록 /files -> POST (임의로 지정)

HTML FORM 사용

• 웹 페이지 회원 관리

GET, POST만 지원

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

• 회원 목록 /members -> GET
• 회원 등록 폼 /members -> GET
• 회원 등록 /members/new, /members -> POST
• 회원 조회 /members/{id}/edit -> GET
• 회원 수정 폼 /members/{id}/edit -> GET
• 회원 수정 /members/{id}/edit, /members/{id} -> POST
• 회원 삭제 /members/{id}/delete -> POST
  • 어쩔 수 없이 컨트롤URI를 써야함

컨트롤 URI(무식하게 쓰면 안된다. 대체제 정도)

• GET, POST만 지원하므로 제약이 존재
• 제약을 해결하기 위해 동사로 된 리소스 경로 사용
• POST /new, /edit, /delete가 컨트롤 URI
• HTTP 메서드로 해결하기 애매한 경우 사용함(HTTP API도 마찬가지)

---

참고하면 좋은 URI 설계 개념

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

REST Resource Naming Guide