728x90
반응형
요구사항: 회원 정보 관리 API
URI(Uniform Resource Identifier)
- 회원 목록 조회 read-member-list
- 회원 조회 read-member-by-id
- 회원 등록 create-member
- 회원 수정 update-member
- 회원 삭제 delete-member
→ 좋은 URI 설계? ⇒ 가장 중요한 것: 리소스 식별
- 리소스의 의미?
- 회원을 등록하고 수정하고 조회하는 것이 리소스 X
- ex. 미네랄을 캐라 → 리소스: 미네랄
- ⇒ 회원이라는 개념 자체가 바로 리소스
- 리소스 어떻게 식별?
- 회원을 등록하고 수정하고 조회하는 것을 모두 배제
- 회원이라는 리소스만 식별하면 됨 ⇒ 회원 리소스를 URI에 매핑
리소스 식별, URI 계층 구조 활용
- 회원 목록 조회 /members
- 회원 조회 /members/{id}
- 회원 등록 /members/{id}
- 회원 수정 /members/{id}
- 회원 삭제 /members/{id}
- 참고: 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장 (member → members)
⇒ 리소스와 행위를 분리
가장 중요한 것: 리소스 식별
- URI는 리소스만 식별
- 리소스와 해당 리소를 대상으로 하는 행위를 분리
- 리소스(명사): 회원
- 행위(동사): 조회, 등록, 삭제, 변경
- 행위(메서드) 어떻게 구분? ⇒ HTTP 메서드
메서드 종류
- 주요 메서드
- GET: 리소스 조회
- POST: 요청 데이터 처리, 주로 등록에 사용
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
- 기타 메서드
- HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
- CONNECT: 대상 리소스로 식별되는 서버에 대한 터널을 설정
- TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
GET
- 리소스 조회
- 서버에 전달하고 싶은 데이터 → query(쿼리 파라미터, 쿼리 스트링) ~> 전달
- 메시지 바디 사용해서 데이터 전달 O, 지원하지 않는 곳 ↑ → 권장 X
POST
- 요청 데이터 처리
- 메시지 바디 ~> 서버로 요청 데이터 전달
- 서버: 요청 데이터 처리
- 메시지 바디 ~> 들어온 데이터를 처리하는 모든 기능 수행
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
요청 데이터를 어떻게 처리한다는 뜻? 예시
- 대상 리소스가 리소스의 고유한 의미 체계 따라 요청에 포함된 표현을 처리하도록 요청
- HTML 양식에 입력된 필드와 같은 데이터 블록 → 데이터 처리 프로세스에 제공
- ex. HTML FORM에 입력한 정보로 회원 가입, 주문 등
- 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
- ex. 게시판 글쓰기, 댓글 달기
- 서버가 아직 식별하지 X 새 리소스 생성
- ex. 신규 주문 생성
- 기존 자원 + 데이터
- ex. 한 문서 끝에 내용 추가
- ⇒ 이 리소스 URI에 POST 요청
→ 요청 데이터 어떻게 처리할지 리소스마다 따로 정해야 함 = 정해진 것 X
정리
- 새 리소스 생성(등록)
- 서버가 아직 식별 X 새 리소스 생성
- 요청 데이터 처리
- 단순히 데이터 생성하거나, 변경하는 것을 넘어 프로세스를 처리해야 하는 경우
- 단순히 값 변경을 넘어 프로세스의 상태가 변하는 경우 ex. 주문 → 결제 완료 → 배달 시작 → 배달 완료
- POST의 결과로 새로운 리소스가 생성되지 X 수도 있음
- ex. POST /orders/{orderId}/start-delivery (컨트롤 URI)
- 다른 메서드로 처리하기 애매한 경우
- ex. JSON으로 조회 데이터 넘겨야 하는데, GET 메서드 사용하기 어려운 경우
PUT
- 리소스를 대체
- 리소스 O → 대체
- 리소스 X → 생성
- ⇒ 덮어버린다
- 클라이언트) 리소스 식별
- 클라이언트) 리소스 위치 알고 URI 지정
- POST와 차이점
PATCH
- 리소스 부분 변경
DELETE
- 리소스 제거
기타 메서드
- HEAD: GET과 동일하지만 메시지 부분 제외하고 상태 줄과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
- CONNECT: 대상 리소스로 식별되는 서버에 대한 터널을 설정
- TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
속성
- 안전(Safe Methods)
- 멱등(Idempotent Methods)
- 캐시가능(Cacheable Methods)
안전(Safe)
- 호출해도 리소스를 변경 X
- Q: 그래도 계속 호출해서, 로그 같은게 쌓여서 장애가 발생하면? A: 안전은 해당 리소스만 고려. 그런 부분까지 고려 X
멱등(Idempotent)
- f(f(x)) = f(x)
- 한 번 호출하든 두 번 호출하든 100번 호출하든 결과 같음
- 멱등 메서드
- GET, PUT, DELETE
- POST: 멱등 X 두 번 호출 → 같은 결제 중복 발생 가능
- 활용
- 자동 복구 매커니즘
- 서버가 TIMEOUT 등으로 정상 응답 X → 클라이언트가 같은 요청 다시 해도 되는가? 판단 근거
- Q: 재요청 중간에 다른 곳에서 리소스 변경? A: 멱등은 외부 요인으로 중간에 리소스가 변경되는 것까지 고려 X
- 사용자1: GET → username:A, age: 20
- 사용자2: PUT → username:A, age: 30
- 사용자3: GET → username:A, age: 30 ⇒ 사용자2의 영향으로 바뀐 데이터 조회
캐시가능(Cacheable)
- 응답 결과 리소스를 캐시해서 사용해도 되는가?
- GET, HEAD, POST, PATCH 캐시 가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려 → 구현 쉽지 X
728x90
반응형
'Spring | SpringBoot' 카테고리의 다른 글
[모든 개발자를 위한 HTTP 웹 기본 지식] 섹션 6. HTTP 상태코드 (0) | 2024.05.01 |
---|---|
[모든 개발자를 위한 HTTP 웹 기본 지식] 섹션 5. HTTP 메서드 활용 (0) | 2024.05.01 |
[모든 개발자를 위한 HTTP 웹 기본 지식] 섹션 3. HTTP 기본 (0) | 2024.05.01 |
[모든 개발자를 위한 HTTP 웹 기본 지식] 섹션 2. URI와 웹 브라우저 요청 흐름 (0) | 2024.05.01 |
[모든 개발자를 위한 HTTP 웹 기본 지식] 섹션 1. 인터넷 네트워크 (0) | 2024.04.29 |