HTTP API 형성
회원 정보 관리 API 만들어라
회원 목록 조회 /read-member-list
회원 조회 /read-member-by-id
회원 등록 /create-member
회원 수정 /update-member
회원 삭제 /delete-member
잘 만들었을까???
가장 중요한 것은 리소스 식별!!!!
API URI 고민
리소스의 의미는 무엇??
회원을 등록 수정 조회하는 건 행위에 해당, 리소스는 회원이라는 것!
리소스 어떻게 식별하는게 좋을까?
회원을 등록, 수정, 조회 하는 것을 모두 배제
회원이라는 리소스만 식별하면 된다.
회원 목록 조회 /members
회원 조회 /members/{id}
회원 등록 /members/{id}
회원 수정 /members/{id}
회원 삭제 /members/{id}
이렇게 만드는 거까지는 좋다 하지만 이들을 구분 하는 방법은??
리소스와 행위를 분리
가장 중요한 것은 리소스를 식별하는 것
URI는 리소스만 식별한다.
리소스는 명사, 행위는 동사
HTTP 메서드 GET, POST
HTTP 메서드 종류
GET : 리소스 조회
POST : 요청 데이터 처리, 주로 등록에 사용
PUT : 리소스를 대체, 해당 리소스 없다면 생성
PATCH : 리소스 부분 변경
DELETE : 리소스 삭제
HEAD : GET과 동일하지만 메시지 부분을 제외하고, 상태줄과 헤더만 반환
OPTIONS : 대상 리소스에 대한 통신 가능 옵션을 설명
1. GET
리소스 조회
서버에 전달하고 싶은 데이터는 query를 통해서 전달
메시지 바디를 사용해서 데이터를 전달 할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 X
2. POST
요청 데이터 처리
메시지 바디를 통해서 서버로 요청 데이터 전달
서버는 요청 데이터를 처리
-> 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행
주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리
요청 데이터를 어떻게 처리한다는 의미??
• HTML 양식에 입력 된 필드와 같은 데이터 블록을 데이터 처리 프로세스에 제공
• 예) HTML FORM에 입력한 정보로 회원 가입, 주문 등에서 사용
• 게시판, 뉴스 그룹, 메일링 리스트, 블로그 또는 유사한 기사 그룹에 메시지 게시
• 예) 게시판 글쓰기, 댓글 달기
• 서버가 아직 식별하지 않은 새 리소스 생성
• 예) 신규 주문 생성
• 기존 자원에 데이터 추가
• 예) 한 문서 끝에 내용 추가하기
POST 정리
-
새 리소스 생성 (등록)
-> 서버가 아직 식별하지 않은 새 리소스 생성 -
요청 데이터 처리
-> 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스르 처리해야 하는 경우
예) 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
-> POST의 결과로 새로운 리소스 생성 않될 수도 있음
- 다른 메서드로 처리하기 애매한 경우
예) JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
애매하면 POST
HTTP 메서드 - PUT, PATCH, DELETE
PUT
리소스를 대체
-> 리소스가 있으면 대체
-> 없으면 생성
-> 쉽게 말해 덮어버린다
중요!!
클라이언트가 리소스를 식별
-> 클라이언트가 리소스 위치를 알고 있어 URI 지정
POST와 차이점
<리소스 있는 경우>
<리소스 없는 경우>
PATCH 리소스 부분 변경
일부분만 변경
DELETE
삭제
HTTP 메서드 속성
1. Safe Methods
호출해도 리소스를 변경하지 않는다.
2. 멱등
한번호출, 여러번 호출, -> 결과는 동일
GET, DELETE, PUT, DELETE -> 멱등 O
POST -> 멱등 X
재요청 중간에 다른 곳에서 리소스 변경한다면?? -> 그 부분까지 고려 X
3. Cacheable
응답 결과 리소스를 캐시해서 사용해도 되는가??
GET, HEAD, POST, PATCH 캐시 가능
실제로는 GET, HEAD 정도로만 캐시 사용
