HTTP API 만들기
예시
요구사항 : 회원 정보 관리 API를 만들어라
- 회원 목록 조회
- 회원 조회
- 회원 등록
- 회원 수정
- 회원 삭제
앱 개발시 서버에서 API와 URL을 설계한다고 가정한다
API URI 설계
uri : uniform resource ldentifier
계층형 구조로 설계
- 회원 목록 조회 /read-member-list
- 회원 조회 /read-member-by-id
- 회원 등록 /create-member
- 회원 수정 / update-member
- 회원 삭제 / delete-member
위와 같이 설계하는 것이 잘 설계한 것일까?
URI설계시 가장 중요한 것은 리소스 식별!!
리소스 식별
- 리소스의 의미는?
- 회원 등록, 회원 수정은 리소스 X
- 회원이라는 개념 자체가 리소스
- 그럼 리소스를 식별하기 쉽게 하려면??
- 등록, 수정, 삭제 모두 배제
- 회원이라는 리소스만 식별하도록 -> 회원 리소스를 URI에 맵핑
API URI 설계 (리소스 식별 버전)
- 회원 목록 조회 /members
- 회원 조회 /members/{id}
- 회원 등록 /mebers/{id}
- 회원 수정 /members/{id}
- 회원 삭제 /members/{id}
- 참고 : 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장 (member -> members)
리소스에 매칭하여 URI 설계
조회, 등록, 수정, 삭제 URI를 구분할 수 없다!!
리소스와 행위를 분리해야한다!
리소스와 행위 분리
- URI는 리소스만 식별
- 리소스와 해당 리소스를 대상으로 하는 행위 분리
- 리소스 : 회원
- 행위 : 조회, 등록, 삭제, 변경
- 명사 : 리소스
- 동사 : 행위
행위는 HTTP 메서드로 구분한다!
