API URI 고민
- URI( Uniform Resource Identifier )
- 리소스의 의미?
- ex. 회원이라는 개념 자체가 바로 리소스이다.
- 리소스를 어떻게 식별을 할까?
- ex. 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI에 매핑
API URI 설계
- 리소스만 반영
- 리소스와 행위를 분리
- URI는 리소스만 식별
- 리소스와 해당 리소스를 대상으로 하는 행위를 분리
- 리소스 : 회원
- 행위 : 조회, 등록, 삭제, 변경
- 리소스는 명사, 행위는 동사
HTTP 메서드 - GET, POST
HTTP 메서드 종류
1) 주요 메서드
- GET: 리소스 조회
- POST: 요청 데이터 처리, 주로 등록에 사용
- PUT: 리소스를 대체, 해당 리소스가 없으면 생성
- PATCH: 리소스 부분 변경
- DELETE: 리소스 삭제
2) 기타 메서드
- HEAD: GET과 동일하지만 메시지 부분을 제외하고, 상태 줄과 헤더만 반환
- OPTIONS: 대상 리소스에 대한 통신 가능 옵션(메서드)을 설명(주로 CORS에서 사용)
- CONNECT: 대상 자원으로 식별되는 서버에 대한 터널을 설정
- TRACE: 대상 리소스에 대한 경로를 따라 메시지 루프백 테스트를 수행
GET
- 리소스 조회
- 서버에 전달하고 싶은 데이터는 query( 쿼리 파라미터, 쿼리 스트링 )를 통해서 전달
- 메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는 곳이 많아서 권장하지 않음
POST
- 요청 데이터 처리
- 메시지 바디를 통해 서버로 요청 데이터 전달
- 서버는 요청 데이터를 처리
- 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
- 주로 전달된 데이터로 신규 리소스 등록, 프로세스 처리에 사용
- 정리
- 새 리소스 생성( 등록 )
- 서버가 아직 식별하지 않은 새 리소스 생성
- 요청 데이터 처리
- 단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
- ex. 주문에서 결제완료 -> 배달시작 -> 배달완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
- POST의 결과로 새로운 리소스가 생성되지 않을 수도 있음
- ex. POST /orders/{orderId}/start-delivery( 컨트롤 URI )
- 다른 메서드로 처리하기 애매한 경우
- ex. JSON으로 조회 데이터를 넘겨야 하는데, GET 메서드를 사용하기 어려운 경우
- 애매하면 POST
- 새 리소스 생성( 등록 )
출처
https://www.inflearn.com/course/http-%EC%9B%B9-%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC/dashboard
'Web > HTTP' 카테고리의 다른 글
[모든 개발자를 위한 HTTP 웹 기본 지식] 6.HTTP 메서드의 속성 3가지( 3/3 ) (0) | 2021.07.23 |
---|---|
[모든 개발자를 위한 HTTP 웹 기본 지식] 5.HTTP 메서드 - PUT, PATCH, DELETE ( 2/3 ) (0) | 2021.07.23 |
[모든 개발자를 위한 HTTP 웹 기본 지식] 3.HTTP 기본 (0) | 2021.07.22 |
[모든 개발자를 위한 HTTP 웹 기본 지식] 2.URI와 웹 브라우저 요청 흐름( URI - Uniform Resource Identifier) (0) | 2021.07.22 |
[모든 개발자를 위한 HTTP 웹 기본 지식] 1.인터넷 네트워크( IP, UDP, TCP) (0) | 2021.07.22 |