6. RESTful API 설계 가이드

Richardson Maturity Model

A way to grade your API according to the constraints of REST

Level 0

expose soap web services in rest style

• https://server/getPosts

Level 1

expose resources with proper url

note : improper use of http methods → 모든 요청을 GET, POST로 받거나 에러/200으로만 반환하는 형태

• https://server/accounts/10

Level 2

level1 + HTTP methods(GET, POST, PUT, DELETE 구분)

Level 3

level2 + HATEOAS

DATA + NEXT POSSIBLE ACTIONS ⇒ 최소한의 end point만을 가지고 다음 url을 알 수 있게 함

설계 시 고려 사항

1. consumer first : 개발자 중심의 설계 보다는 소비자 입장에서 간단명료하고 직관적인 API 설계
2. make best use of HTTP : HTTP 장점 살리기
3. Request methods

• GET
• POST
• PUT
• DELETE

1. Response Status

• 200
• 404
• 400
• 201
• 401

1. No secure info in URI
2. use plurals

prefer users to user

1. use nouns for resources
2. for exceptions

define a consistent approach

url은 단순하게, parameter/header/HTTP 상태코드를 다양하게

PUT /gists/{id}/star

DELETE /gists/{id}/star