API URI 설계
- 리소스 식별
- URI 계층 구조 활용
예시
- 회원 목록 조회
/members - 회원 목록 조회
/members - 회원 목록 조회
/members - 회원 목록 조회
/members
리소스와 행위를 분리한다
- URI : 리소스만 식별하며, 행위는 식별하지 않는다.
- 리소스 = 명사 / 행위 = 동사
URI 네이밍시 참고!
계층 구조상 상위를 컬렉션으로 봄
→ 복수단어 사용 권장!
- member (X)
- members (O)
HTTP 메서드 종류
GET: 리소스 조회POST: 요청 데이터 처리, 주로 등록에 사용PUT: 리소스를 대체, 해당 리소스가 없으면 생성PATCH: 리소스 부분 변경DELETE: 리소스 삭제
기타 메서드
HEAD: GET과 동일하지만 메시지 부분을 제외하고 상태 줄과 헤더만 반환OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 주로 설명 (주로 CORS에서 사용)CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
GET
- 서버에 전달하고 싶은 데이터는 query parameter(query string)를 통해 전달
- 메시지 바디를 사용해서 데이터 전달도 가능은 하지만, 지원하지 않는 곳이 많아 권장하지 않음
POST
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리함 (메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능들 수행)
- 전달된 데이터로 신규 리소스를 등록하고, 프로세스 처리에 사용함
기능
- 새 리소스 생성
- 요청 데이터 처리 (프로세스 처리)
- 다른 메서드로 처리하기 어려운 경우
- JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
- 애매하면 POST 사용
PUT
- 리소스를 대체함
- 리소스가 있으면 대체, 없으면 생성
- 즉, 덮어씌워버림!
- POST와의 차이점 : 클라이언트가 리소스 위치를 알고 URI를 지정한다.
PATCH
- 리소스 부분을 변경함
💡 PUT과 PATCH의 차이
⇒ 멱등성
: 어떤 대상에 같은 연산을 여러 번 적용해도 결과가 달라지지 않는 성질
- PUT : 멱등성 보장
- PATCH : 멱등성 보장하지 않을 수 있음
DELETE
- 리소스를 제거함
HTTP 메서드의 속성들
- 안전함 여부
- 멱등성 여부
- 캐시 가능 여부
안전함
- 호출해도 리소스를 변경하지 않음
(로그 데이터 고려 X)
멱등성(Idempotent)
- f(f(x)) = f(x)
POST는 멱등 메서드가 아님! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있음
📌 중요한 이유
- 자동 복구 메커니즘을 짤 떄 고려
- 서버가 TIMEOUT 등으로 정상 응답을 못 주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가?
캐시 가능 (Cacheable)
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
GET,HEAD,POST,PATCH캐시 가능- 실제로는
GET,HEAD정도만 캐시로 사용 POST,PATCH: 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음
