1. HTTP API 생성
1) API URI 설계
URI는 리소스 식별이 가장 중요함- 리소스 : 회원을 등록하고 수정하고 조회하는 것이 아닌, 회원 개념 자체
- 회원이라는 리소스만 식별하면 됨 → 회원 리소스를
URI에 매핑
- 회원 목록 조회
- 회원 조회
- 회원 등록
- 회원 수정
- 회원 삭제
→ 모두 /memebers/{id} (목록 조회의 경우에는 {id}제외)
- 리소스 : 회원 → 명사
- 행위(메서드) : 조회, 등록, 수정, 삭제, 변경 → 동사
2. HTTP Method
1) HTTP 메서드 종류
GET: 리소스 조회POST: 요청 데이터 처리PUT: 리소스 대체, 해당 리소스가 없으면 생성PATCH: 리소스 부분 변경DELETE: 리소스 삭제
+) 참고 메서드
HEAD:GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 변경OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)를 설명(주로CORS에서 사용)CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
2) GET Method
- 리소스 조회
- 서버에 전달하고 싶은 데이터는
query(Query parameter, Query String)를 통해서 전달 - 메시지 바디로 데이터를 전달하는 방식은 권장하지 않음
- 기존에 저장된 데이터를 응답으로 받음(조회)
3) POST Method
- 요청 데이터 처리
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능 수행
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
- 신규 리소스 식별자 생성(등록)
POST가 사용되는 기능
- HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
- 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
- 서버가 아직 식별하지 않은 새 리소스 생성
- 기존 자원에 데이터 추가
→ 이 리소스 URI에 POST 요청이 오면 요청 데이터를 어떻게 처리할지 리소스마다 따로 정해야 함 → 정해진 것이 없음
POST 역할 정리
- 새로운 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
- 요청 데이터 처리
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
- 주문에서
결제완료 → 배달시작 → 배달완료처럼 단순히 값 변경을 넘어서 프로세스의 상태가 변경되는 경우 POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음POST /orders/{orderId}/start-delivery(컨트롤 URI)
- 다른 메서드로 처리하기 애매한 경우
JSON으로 조회 데이터를 넘겨야 하는데,GET메서드를 사용하기 어려운 경우- 이렇게 애매한 경우
POST사용
4) PUT Method
- 리소스를 대체
- 리소스가 있으면 대체, 없으면 생성(덮어쓰기)
POST와 다르게 클라이언트가 리소스를 식별함- 클라이언트가 리소스 위치를 알고
URI를 지정함 - 리소스가 있는 경우
- 리소스가 없는 경우
- 리소스를 완전히 대체하기 때문에 기존에 존재했던 필드 중에 일부를 넘기지 않으면 해당 필드의 값은 사라짐
5) PATCH Method
- 리소스 부분 변경
PUT과 달리 일부 필드의 값만 넘기면, 그 필드의 값만 변경됨
PATCH가 지원이 안되는 경우에는POST를 사용하면 됨
6) DELETE Method
- 리소스 제거
3. HTTP 메서드 속성
1) Safe(안전) Methods
- 호출해도 리소스를 변경하지 않음
- 하지만 안전은 해당 리소스만 고려하고, 계속 호출해서 로그가 쌓여 장애가 발생하는 경우까지는 고려하지 않음
2) Idempotent(멱등) Methods
f(f(x)) = f(x)
- 한 번 호출하든 두 번 호출하든 100번 호출하든 결과가 똑같은 것
멱등 메서드
GET: 몇 번을 조회해도 같은 결과가 조회됨PUT: 결과를 대체, 따라서 같은 요청을 여러 번 해도 최종 결과는 같음DELETE: 결과를 삭제, 같은 요청을 여러 번 해도 삭제된 결과는 같음POST: 멱등이 아님, 두 번 호출하면 같은 결제가 중복해서 발생할 수 있음
활용
- 자동 복구 메커니즘에 사용이 가능함
- 서버가 타임아웃 등으로 정상 응답을 주지 못했을 때, 클라이언트가 같은 요청을 다시 해도 되는가에 대한 판단 근거
- 그러나 멱등은 재요청 중간에 다른 곳에서 리소스를 변경하는 경우가 발생하는 것처럼, 외부 요인으로 중간에 리소스가 변경되는 것까지 고려하지는 않음
3) Cacheable(캐시가능) Methods
- 응답 결과 리소스를 캐시해서 사용해도 되는가
- 캐시 가능 :
GET, HEAD, POST, PATCH- 실제로는
GET, HEAD정도만 캐시로 사용함 POST, PATCH는 본문 내용까지 캐시 키로 고려하는 구현이 쉽지 않음
- 실제로는
강의 출처 : 인프런 : 모든 개발자를 위한 HTTP 웹 기본 지식
Backend development