HTTP 메서드 활용[HTTP API 설계 예시]

HTTP API 설계 - POST 기반 (회원 관리 API)

 

 

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

 

HTTP API 설계 - PUT 기반 (정적 컨텐츠/원격 파일 관리 API)

 

 

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

 

HTTP API 설계 - HTML FORM 기반 (웹 페이지 회원 관리)

 

 

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

 

참고하면 좋은 URI 설계 개념

 

 

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