http api 설계 예시 - Githubissues

http api 설계 예시 http API - 컬렉션... post 기반 등록 예) 회원 관리 API 제공 http API - 스토어... put 기반 등록 예) 정적 컨텐츠 관리, 원격 파일 관리 html form 사용... 웹 페이지 회원 관리. get, post만 지원

회원 관리 시스템 api 설계 - post 기반 등록 회원 목록 /members -> GET 회원 등록 /members -> POST 회원 조회 /members/{id} -> get 회원 수정 /members/{id} -> patch, put, post 회원 삭제 /members/{id} -> delete

post - 신규 자원 등록 특징 클라이언트는 등록될 리소스의 URI를 모른다... 회원 등록 /members -> POST POST /members 서버가 새로 등록된 리소스 URI를 생성해준다 http/1.1 201 Created Location /members/100

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

API 설계 -PUT 기반 등록 파일 /files -> GET 파일 조회 /files/{filename} -> GET 파일 등록 /files/{filename} -> PUT 파일 삭제/files/{filename} -> DELETE 파일 대량 등록 /files -> POST

put - 신규 자원 등록 특징 클라이언트가 리소스 URI를 알고 잇어야함!!! 클라이언트가 직접 리소스의 URI를 지정한다 스토어 (Store) 클라이언트가 관리하는 리소스 저장소 클라이언트가 리소스의 URI를 알고 관리 여기서 스토어는 /files

html form 사용 html form은 get, post 만 지원 ajax 같은 기술을 사용해서 해결 가능 -> 회원 API 참고 여기서는 순수 html, html form이야기 get, 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

html form을 사용하면 get post만 지원... 컨트롤 URI:

get post 만 지원하므로 제약이 있음
이런 제약을 해결하기 위해 동사로 된 리소스 경로 사용
post의 /new/edit/delete가 컨트롤 URI
http 메서드로 해결하기 애매한 경우 사용 (http API 포함)

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

liamchoi943 / http

http api 설계 예시 #12