728x90
1. URl 설계
- 리소스식별이 가장 중요하다.
- 리소스: 주요 자원, 회원 정보 관리 API에서 회원이란 개념 자체가 리소스
- 리소스 없이 작성
- 회원 목록 조회 /read-member-list
- 회원 조회 /read-member-by-id
- 회원 등록 /create-member
- 회원 수정 /update-member
- 회원 삭제 /delete-member
- 리소스를 생각해서 재작성
- 참고: 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용 권장(member -> members)- 회원 목록 조회 /members
- 회원 조회 /members/{id}
- 회원 등록 /members/{id}
- 회원 수정 /members/{id}
- 회원 삭제 /members/{id}
2. 리소스와 행위(method) 분리
- URI는 리소스만 식별
- (명사)리소스: members - 이것만으로는 뭐할지 알 수 가 없다.
- (동사) 행위: 조회, 등록, 삭제, 변경
- 행위(method)는 어떻게 구분할까 -> HTTP 메서드로 구분
3. HTTP 메서드
- 주요 method
- GET: 리소스 조회
- POST: 요청 데이터 처리, 주로 등록에 사용
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성 ex) folder에 file 넣는것, 동일한 file존재시 덮어쓰기
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
- 기타 method
- HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
- CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정
- TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
3.1. GET
- 리소스 조회
= members 조회 - 서버에 전달하고 싶은 데이터는 query를 통해서 전달
- 메시지 바디를 사용해서 데이터 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않는다.
- post는 body 사용해도 상관 없다.
3.2. POST
- 요청 데이터 처리
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행 - 주로 전달된 데이터로 신규 리소스(member) 등록, 프로세스 처리에 사용
- 요청 data를 처리한다는 의미
- 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 -> 정해진 것이 없음
- HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
- 게시판 글쓰기, 댓글 달기
- 신규 주문 생성
- 한 문서 끝에 내용 추가하기
- 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 -> 정해진 것이 없음
- 처리할 리소스 큰 틀
- 새 리소스 생성(등록)
- 요청 데이터 처리 - 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
- 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
- POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음 -> 컨트롤 URI 사용 (리소스 + 행위)로 이루어진 uri
- 다른 메서드로 처리하기 애매한 경우 post 사용
- 조회의 get 빼곤 거의 post 사용
3.3. PUT, PATCH, DELETE
PUT
리소스를 대체 - 있으면 완전히 대체, 없으면 생성
client가 리소스 식별 - client가 리소스 위치를 알고 URI 지정
cf) POST는 리소스 위치를 모른다 (차이점)
PATCH
리소스 부분 변경
DELETE
리소스 제거
4. HTTP 메서드의 속성
- 종류
- 안전 : 리소스의 변경 여부
- 멱등 : 반복 호출에도 변경의 변화 되는지 여부
- 캐시가능
4.1. 안전
- 해당 리소스에 한해서 호출해도 리소스의 변경이 없다.
- get, head 빼고 다 변경된다.
4.2. 멱등
- 한 번 호출하든 두번 호출하든 100번 호출하든 결과가 똑같다.(딱 그 행위에 한해서만)
- 멱등 O: GET, PUT, DELETE
- 멱등 X: POST -> 같은 결제가 중복해서 발생할 수 있다.
- 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.
4.3. 캐시가능(web 정보를 내 local PC에 저장하고 있는 것)
- GET, HEAD, POST, PATCH 가능
- 실제로 GET,HEAD 정도만 캐시 사용
- POST, PATCH 중요정보가 있을 수 있으므로 캐시 키도 고려해야함
-> 캐시 유지가 힘들다.
이전 발행글: 3. HTTP
다음 발행글: 5. HTTP 메서드 활용
출처: Inflearn-모든 개발자를 위한 HTTP 웹 기본 지식