반응형
4. HTTP 메서드
4.1. HTTP API를 만들어보자
'회원 정보 관리 API의 URI를 설계해보자'
- 회원 목록 조회 /read-member-list
- 회원 조회 /read-member-by-id
- 회원 등록 / create-member
- 회원 수정 /update-member
- 회원 삭제 /delete-member
'이것은 좋은 URI 설계일까?'
- URI 설계시 가장 중요한 것은 리소스 식별이다
- 리소스의 의미는 뭘까?
- 회원을 등록하고 수정하고 조회하는게 리소스가 아니다!
- 예) 미네랄을 캐라 -> 미네랄이 리소스
- 회원이라는 개념 자체가 바로 리소스다.
- 리소스는 어떻게 식별하는게 좋을까?
- 회원을 등록하고 수정하고 조회하는 것을 모두 배제
- 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑
- URI 계층 구조를 활용한다.
- 슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다.
- 예) http://test.example.com/members/{id}
'리소스 식별, URI 계층 구조를 활용하여 URI 설계를 다시 해보자!'
- 회원 목록 조회 /members
- 회원 조회 /members/{id}
- 회원 등록 /members/{id}
- 회원 수정 /members/{id}
- 회원 삭제 /members/{id}
- 참고: 계층 구조상 상위를 컬렉션으로 보고 복수 단어 사용 권장(member -> members)
'같은 리소스를 사용하는 경우, 어떻게 구분해야 할까?'
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리
- 리소스: 회원
- 행위: 조회, 등록, 삭제, 변경
- 리소스는 명사, 행위는 동사 (미네랄을 캐라)
- 행위(메서드)는 HTTP 메서드로 구분한다.
[ HTTP 메서드 ]
- GET: 리소스 조회
- 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달
- 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
- POST: 요청 데이터 처리, 주로 등록에 사용
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
- 애매한 곳은 POST를 사용하면 된다 (다른 메서드로 처리하기 애매한 경우)
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- POST와 차이점: 클라이언트가 리소스 위치를 알고 URI 지정
- 예) /members/{id}
- PUT은 기존 리소스를 삭제하고 완전히 대체하기 때문에 중요한 데이터는 PUT을 사용하면 안된다.
(중요한 데이터를 부분 수정하려면 PATCH를 사용한다)
- POST와 차이점: 클라이언트가 리소스 위치를 알고 URI 지정
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
[ HTTP 메서드 속성 ]
- 안전 (Safe Methods)
- 호출해도 리소스를 변경하지 않는다.
- GET, HEAD 메서드가 안전 메서드이다.
- 멱등 (Idenmpotent Methods)
- 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같다. (외부 요인으로 중간에 리소스가 변경되는 것은 고려 X)
- 멱등 메서드
- GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
- PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
- DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
- POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
- PATCH: 멱등으로 설계할 수도 있지만, 멱등이 아니게 설계할 수도 있다. (참고)
- 활용
- 자동 복구 메커니즘
- 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가? 판단 근거
- 캐시가능 (Cacheable Methods)
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH 메서드가 캐시 가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 교려해야 하는데, 구현이 쉽지 않음
- POST, PATCH는 본문 내용까지 캐시 키로 교려해야 하는데, 구현이 쉽지 않음
References
https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC
'개발 > Network' 카테고리의 다른 글
[HTTP] 실무에 필요한 네트워크 기초 (6) (0) | 2023.02.10 |
---|---|
[HTTP] 실무에 필요한 네트워크 기초 (5) (0) | 2023.02.08 |
[HTTP] 실무에 필요한 네트워크 기초 (3) (0) | 2023.02.06 |
[HTTP] 실무에 필요한 네트워크 기초 (2) (0) | 2023.02.02 |
[HTTP] 실무에 필요한 네트워크 기초 (1) (0) | 2023.02.02 |