[Spring] RESTful API 설계 가이드

 

서버 개발자는 Over-Fetching 과 Under-Fetching 을 신경쓰며 API 를 디자인 해야한다.

REST API 디자인 시 필요한 정보들을 잘 정리한 블로그 포스팅들을 공유한다.

 

# 예시 (QueryString &  PathVariable)

/users // Fetch a list of users
/users?occupation=programmer // Fetch a list of programmer user
/users/123 // Fetch a user who has id 123

/users [GET] // Fetch a list of users
/users [POST] // Create new user
/users/123 [PUT] // Update user
/users/123 [DELETE] // remove user

 

 

# Reference 

1. QueryString 과 PathVariable 사용예시

올바른 URL 설계 : 1) Query string과 Path Variable 이해하기

 

2. 전반적인 RESTful API 설계 가이드

RESTful API 설계 가이드