API URI 설계 ( URI : Uniform Resouce Identifier ) - URI 설계의 가장 중요한 것은 리소스 식별 - 리소스와 해당 리소스를 대상으로 하는 행위를 분리해야 함 - 리소스 : 회원 - 행위 : 조회, 등록, 삭제, 변경 ( HTTP 메서드가 담당 ) 리소스의 의미 - 회원을 등록하고 수정하고 조회하는 것이 리소스가 아니라 회원이라는 개념 자체가 리소스
HTTP 메서드 종류
주요 메서드 - GET : 리소스 조회 - POST : 요청 데이터 처리, 주로 등록에 사용 - PUT : 리소스를 대체, 해당 리소스가 없으면 생성 - PATCH : 리소스 부분 변경 - DELETE : 리소스 삭제
HTTP 메서드 - GET, POST
GET - 리소스 조회 - 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해 전달 - 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
POST - 요청 데이터 처리 - 메시지 바디를 통해 서버로 요청 데이터 전달 - 서버는 요청 데이터를 처리 ( 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능 수행 ) - 주로 전달된 데이터로 신규 리소스 등록, 프로레스 처리에 사용
*POST 사용 예 1. 새 리소스 생성 ( 등록 ) 2. 요청 데이터 처리 3. 다른 메서드로 처리하기 애매한 경우 - JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
- HTML FORM에 입력된 정보로 회원가입, 주문 등에 사용 - 게시판 글쓰기, 댓글 달기 - 신규 주문 생성 - 한 문서 끝에 내용 추가
HTTP 메서드 - PUT, PATCH, DELETE
PUT - 클라이언트가 리소스 식별 : 리소스가 있으면 대체, 없으면 생성 - POST는 리소스를 식별하지 않음 - 기존 리소스를 완전히 대체 ( 덮어버림 ) 리소스 부분 확인서버에서 리소스 대체됨
PATCH - 리소스 부분 변경 - PATCH가 지원되지 않는 서버도 있을 수 있음, 그럴 경우 POST를 사용
리소스 확인age만 변경됨 - 리소스 부분 변경 DELETE - 리소스 제거 memebers/100 삭제 요청리소스 제거
HTTP 메서드의 속성
1. 안전 (Safe Methods) - 호출해도 리소스를 변경하지 않는다.
2. 멱등 (Idempotent Methods) - 몇 번 호출하든 결과가 똑같다 - 멱등 메서드 - GET : 한 번 조회, 두 번 조회 모두 같은 결과가 조회됨 - PUT : 결과를 대체하기 때문에 같은 요청을 여러번 해도 최종 결과는 같음 - DELETE : 같은 요청을 여러번 해도 삭제된 결과는 똑같음
- POST : 멱등이 아님, 두 번 호출하면 같은 결제가 중복해서 발생 할 수 있음
- 활용 - 자동 복구 메커니즘 - 판단 근거 : 서버가 TIMEOUT 등으로 정상 응답을 못주었을 때, 클라이언트가 같은 요청을 다시 해도 되는지
- 멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않음
3. 캐시가능 (Cacheable Methods) - 응답 결과 리소스를 캐시해서 사용해도 되는가? - 캐시 가능 메서드 - GET, HEAD, POST, PATCH - 실제로는 GET, HEAD 정도만 캐시로 사용 - POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음
