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

HTTP API 설계 예시

•  HTTP API - 컬렉션
  • POST 기반 등록
  • ex) 회원 관리 API 제공
• HTTP API - 스토어
  • PUT 기반 등록
  • ex) 정적 컨텐츠 관리, 원격 파일 관리
• HTML FORM 사용
  • 웹 페이지 회원 관리
  • GET, POST만 지원

 

회원 관리 시스템

API 설계 - POST 기반 등록

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

 

 

파일 관리 시스템

API 설계 - PUT 기반 등록

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

 

HTML FORM 사용

• 회원 목록       /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

https://restfulapi.net/resource-naming 참고