1. HTTP API를 만들어보자
요구사항
회원 정보 관리 API를 만들어라.
- 회원 목록 조회
- 회원 조회
- 회원 등록
- 회원 수정
- 회원 삭제
API URI 설계
- 회원 목록 조회 /read-member-list
- 회원 조회 /read-member-id
- 회원 등록 /create-member
- 회원 수정 /update-member
- 회원 삭제 /delete-member
이것은 좋은 URI 설계인가?
가장 중요한 것은리소스 식별!
API URI 고민
-
리소스가 뭐임?
- 회원을 등록하고 수정하고 조회하는게 리소스가 아니다.
- 회원이라는 개념 자체가 리소스!
ex. 미네랄을 캐라 -> 미네랄
-
회원이라는 리소스만 식별 -> 회원 리소스를 URI에 매핑
API URI 설계를 다시 해보자
리소스 식별, URI 계층 구조 활용
- 회원 목록 조회 /members
- 회원 조회 /members/{id}
- 회원 등록 /members/{id} ?
- 회원 수정 /members/{id} ?
- 회원 삭제 /members/{id} ?
어떻게 구분해야되는 것인가?
리소스와 행위를 분리
가장 중요한 것은 리소스를 식별하는 것
- URI는 리소스만 식별!
- 리소스 : 회원 (명사)
- 행위 : 조회, 등록, 삭제, 변경 (동사) -> HTTP 메서드를 쓰자!
2. HTTP 메서드 - GET, POST
HTTP 메서드 종류
주요 메서드
- GET : 리소스 조회
- POST : 요청 데이터 처리, 주로 등록에 사용
- PUT : 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH : 리소스 부분 변경
- DELETE : 리소스 삭제
GET
- 리소스 조회
- query를 통해서 데이터를 전달
전달 과정
POST
- 요청 데이터 처리
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
전달 과정
정리
-
새 리소스 생성 (등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
-
요청 데이터 처리
- 단순히 데이터 생성 및 변경을 넘어 프로세스를 처리해야 하는 경우
- POST 결과로 새로운 리소스가 생성되지 않을 수도 있음
(컨트롤 URI)
-
다른 메서드로 처리하기 애매한 경우
- JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
조회에는 GET으로, 데이터 변경, 프로세스 진행, 어쩔 수 없는 경우엔 POST---
3. HTTP 메서드 - PUT, PATCH, DELETE
PUT
- 리소스를 대체
- 리소스가 있으면 완전히 대체
- 리소스가 없으면 생성
- 클라이언트가 리소스를 식별!!!
- 클라이언트가 리소스의 위치를 알고 URI 지정 (POST와의 차이점)
전달과정
기존것을 지우고 완전히 대체해버림
부분을 변경하고싶다면 뭐를 써야되는걸까?
PATCH
- 리소스 부분 변경
- 지원이 안되는 서버도 종종 있는 경우 POST를 사용!
전달과정
DELETE
- 리소스 제거
전달과정
4. HTTP 메서드의 속성
- 안전 (Safe Methods)
- 멱등 (Idempotent Methods)
- 캐시가능 (Cachable Methods)
안전 (safe)
- 호출해도 리소스 변경 X
ex. GET, HEAD : 안전
POST, DELETE, PATCH : 변경이 발생 즉, 안전하지 않음- 해당 리소스가 변하는 것만 고려한다.
멱등 (Idempotent)
- 한 번 호출하든 100번 호출을 하든 결과가 똑같아야 한다.
- 즉, 최종 결과물이 같아야 함
- 메서드
- GET
- PUT
- DELETE
POST는 멱등이 아니다!
- 활용
- 자동 복구 매커니즘
ex. DELETE를 호출했는데 응답이 없어서 재시도해도 되나? = OK
- 자동 복구 매커니즘
- 재요청 중간에 다른 곳에서 리소스를 변경하는 것 까지는 고려하지 않음!
ex. 사용자1 : GET -> username:A, age:20
사용자2 : PUT -> username:A, age:30
사용자1 : GET -> username:A, age:30 [사용자2의 영향으로 변경된 데이터 조회]
캐시가능 (Cachable) [중요]
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH로 가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음
