HTTP API를 만들어보자
- 회원 목록 조회
- 회원 조회
- 회원 등록
- 회원 수정
- 회원 삭제
API URI 설계
URI - Uniform Resource Identifier
- 회원 목록 조회 /read-member-list
- 회원 조회 /read-member-by-id
- 회원 등록 /create-member
- 회원 수정 /update-member
- 회원 삭제 /delete-member
그럴듯해 보이지만 정말 이것이 좋은 URI 설계인가?
API URI 고민
- 리소스의 의미는 뭘까?
- 회원을 등록하고 수정하고 조회하는게 리소스가 아니다!
- 예) 미네랄을 캐라 -> 미네랄이 리소스
- 회원이라는 개념 자체가 바로 리소스다.
- 리소스를 어떻게 식별하는게 좋을까?
- 회원을 등록하고 수정하고 조회하는 것을 모두 배제
- 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑
API URI 설계
리소스 식별, URI 계층 구조 활용
- 회원 목록 조회 /members
- 회원 조회 /members/{id}
- 회원 등록 /members/{id}
- 회원 수정 /members/{id}
- 회원 삭제 /members/{id}
문제는 리소스를 사용하면 행위에 대한 것을 구분할 수가 없다.
리소스와 행위를 분리
가장 중요한 것은 리소스를 식별하는 것이다.
- URI는 리소스만 식별해야한다. 행위를 식별하면 안된다.
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리
- 리소스:회원
- 행위:조회, 등록, 삭제, 변경
- 리소스는 명사, 행위는 동사 (미네랄을 캐라)
행위는 GET, POST를 통해 구분할 수 있다.
HTTP 메서드 - GET, POST
- GET: 리소스 조회
- POST: 요청 데이터 처리, 주로 등록에 사용
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
기타 메서드
HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
바디빼고 헤더만 줘.
OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정
TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
CONNECT, TRACE는 거의 안씀
GET
- 리소스 조회
- 서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링)를 통해서 전달
- 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
1. 메시지 전달
2. 서버 도착
3. 응답 데이터
POST
- 요청 데이터 처리
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용한다.
1. 메시지 전달
2. 신규 리소스 생성
3. 응답 데이터
요청 데이터를 어떻게 처리한다는 뜻일까?
-
예시
-
HTML 양식에 입력된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
- 예) HTML FORM에 입력한 정보로 회원가입, 주문 등에서 사용
-
게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
- 예) 게시판 글쓰기, 댓글 달기
-
서버가 아직 식별하지 않은 새 리소스 생성
- 예) 신규 주문 생성
-
기존 자원에 데이터 추가
- 예) 한 문서 끝에 내용 추가하기
-
-
결론 - 정해진 것이 없기 때문에 리소스마다 따로 정해야함.
정리 POST
새 리소스 생성(등록)
- 서버가 아직 식별하지 않은 새 리소스 생성
요청 데이터 처리
- 프로세스를 처리해야 하는 경우
- 예) 주문에서 결제완료 -> 배달 시작 -> 배달완료 처럼 단순히 값 변경을 하는 것이 아니라 프로세스의 상태가 변경되는 경우
- POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
- 예) 미네랄을 캐라라는 문자에서 동사를 URI로 사용할 때도 있다. (컨트롤 URI)
다른 메서드로 처리하기 애매한 경우
- 예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
- 애매하면 POST
POST는 모든 것을 할 수 있지만, 조회의 데이터는 최대한 GET을 사용하는 것이 좋고, 정말 어쩔 수 없이 사용해야할 때 POST를 사용하면 된다.
PUT
PUT은 리소스가 없으면 만들고 있으면 덮어버린다.
POST와 큰 차이점은 /members/100과 같이 리소스의 위치를 정확히 알고 있다는 점이다.
(POST는 /members 라고만 입력하여 진행한다.)
리소스가 있는 경우
리소스가 없는 경우
중요한 점 - 리소스가 완전히 대체된다.
기존 리소스를 완전히 갈아치우기 때문에 없는 필드들은 삭제되게 된다.
그렇다면 수정을 하고싶다면 어떻게 해야할까?
PATCH를 사용하면 된다.
PATCH
- 리소스 부분 변경
부분 변경
가끔 PATCH를 지원하지 않는 서버도 있다. 그럴 경우에는 POST를 이용하면 된다.
DELETE
- 리소스 제거
HTTP 메서드의 속성
- 안전(Safe Methods)
- 멱등?(Idempotent Methods)
- 캐시가능(Cacheable Methods)
안전
- 호출해도 리소스를 변경하지 않는다.
- GET으로 예를 들면 조회만 하기 때문에 안전하다. 리소스가 변경될 위험이 없다.
- 하지만 POST는 변경할 수 있기 때문에 안전하지 않다.
- 안전은 해당 리소스가 변하냐 변하지 않냐 기준으로만 정한다.
멱등
- 이게뭐야
- 몇 번을 호출해도 결과가 똑같다.
- 멱등 메서드
-
GET: 한 번 조회하든, 두 번 조회하든 같은 결과가 조회된다.
-
PUT: 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
- /members/100을 30번 PUT해도 덮어씌우기 때문에 결과가 똑같다.
-
DELETE: 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
-
POST: 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.
-
- 그럼 언제쓰냐
- 자동 복구 메커니즘
- 예) DELETE를 실행했을때 잘 삭제되었는지 알 수가 없을때 한번 더 DELETE를 실행하면 된다. (결과가 똑같으니까)
참고로 멱등의 기준에 외부요인으로 중간에 리소스가 변경되는 것을 고려하지 않는다.
캐시가능
기준은 간단하게 웹 브라우저가 내부에 데이터를 저장할 수 있냐 없냐이다.
- GET, HEAD, POST, PATCH 캐시가능
- 실제로는 GET, HEAD 정도만 캐시로 사용
- POST, PATCH는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않음
