RESTful API 손쉽게 사용하기

서버 파트장 준커/김준기
2023. 09. 20.

발표의 주제 및 포커싱
어떻게하면 서버 개발을 하면서 손쉽게
REST API를 사용할 수 있을까?

API란?
Application Programming Interface

API란?
애플리케이션 간에 데이터를 주고받기 위한 인터페이스

날씨 API
날씨 정보를 알려줘!
여기요!!
API

API의 방식
- HTTP
- RPC
- SOAP
- WebSocket
- GraphQL

REST API란?
REST API RESTful
= API

REST란?
Representational State Transfer

REST란?
자원을 이름(표현)으로 구분하여 자원의 상태(정보)를 전달한다.

RESTful
• 균일한 인터페이스
• 클라이언트 서버구조
• Stateless
• 캐시가능성
• 계층 구조
• 주문형 코드(선택사항)

그래서 어떻게 쓰는건데?
리소스
행위

그래서 어떻게 쓰는건데?
HTTP Method URI

API 설계 시 흔히 하는 실수

URI에는 리소스만!
ex) 미네랄을 캐라 → 미네랄이 리소스.
하지만 리소스만 담기면 행위가 모호해지고 중복이 생김

HTTP Method
- GET
- POST
- PUT
- PATCH
- DELETE
- CONNECT
- OPTIONS
- TRACE
- HEAD

GET
리소스 요청
GET /members
GET /member/1
GET Method는 Request Body 지원 X

Swagger에서 GET
리소스 요청

POST
요청 데이터 처리, 등록
POST /member
Request Body로 데이터 전달
만능 Method인 POST

PUT
리소스를 대체, 해당 리소스가 없으면 생성
PUT /member/1
POST와도 비슷하고 PATCH와도 비슷함

PATCH
리소스 부분 변경
PATCH /member/1
PUT과 비슷함

DELETE
리소스 삭제
DELETE /member/1
DELETE Method는 Request Body 지원 X
DELETE /members

POST VS PUT
POST도 등록이 가능하고 PUT도 등록이 가능하다
POST PUT
POST는 등록될 데이터의 위치를 지정 X PUT은 등록될 데이터의 위치를 지정 O
POST /member PUT /member/77

PUT VS PATCH
PUT도 수정이 가능하고 PATCH도 수정이 가능하다
PUT PATCH
PUT은 덮어쓰기 PATCH는 부분 변경

Recommended