티스토리 뷰

etc

REST API 설계 가이드

kingsubin 2021. 3. 19. 23:30

Richardson Maturity Model 

잘 정리된 글 brunch.co.kr/@pubjinson/12

 

레벨 3은 Hypermedia Controls 를 추가한다.

요점은 다음에 무엇을 할 수 있는지와 그것을 하기 위해 다루어야 할 리소스의 URI 를 알려준다.

장점은 서버가 클라이언트에 문제를 일으키지 않고 URI schema 를 변경할 수 있다는 것이다.

 

상세보기에서 삭제할 수 있는 정보, 수정할 수 있는 정보 같은걸 넣어줄 수 있다.
- 하나의 리소스에서 파생할수있는 추가작업도 확인 가능 
- 개발자가 해야할 작업의 양이 늘어남
- 클라이언트 입장에서는 추가정보를 한번에 얻을수있다는 장점이 있음.



1. Counsumer first

2. Make best use of HTTP

3. Request methods 

  - 전부 POST 로만 처리하려고 하지않기.

4. response status

  - 성공 코드가 있다면 200 으로만 처리하지않고 200, 201 이런식으로 분리하기 

5. No secure info in URI

  - 중요 정보는 URI 에 담지않음

6. Use plurals 

  - post -> posts, user -> users : 이런식으로 복수형 사용 

7. User nouns for resources 

  - 동사형 보다는 명사형으로

8. define a consistent approach

  - 일관된 엔드포인트 사용 

  ex) PUT /gists/{id}/star, DELTE /gists/{id}/star 

'etc' 카테고리의 다른 글

JSend  (0) 2021.03.24
trailing commas  (0) 2021.03.21
Forward, Redirect  (0) 2021.03.04
form novalidate  (0) 2021.03.01
.DS_Store  (0) 2021.02.24