REST API 중심 규칙

  • URI는 정보의 자원을 표현해야 한다.
    : 리소스명은 동사보다 명사 사용
  • 자원에 대한 행위는 HTTP Method (GET,POST,PUT,DELETE)등으로 표현
# bad 💩
GET /getTodos/1
GET /todos/show/1

# good ✨
GET /todos/1

# bad 💩
GET /todos/delete/1

# good ✨
DELETE /todos/1

HTTP Method

  • GET : index,retrieve / payload X / 모든, 특정 리소스 조회
  • POST : create / payload O / 리소스 생성
  • PUT : replace / payload O / 리소스 전체 교체
  • PATCH : modify / payload O / 리소스 일부 수정
  • DELETE : delete / payload X / 모든,특정 리소스 삭제

REST API의 구성

  • REST API 는 자원(Resource), 행위(Verb), 표현(Reprsentations)의 3가지 요소로 구성
  • REST는 자체 표현 구조로 구성되어 REST API만으로 요청을 이해할 수 있다.
구성요소내용표현방법
Resource자원HTTP URI
Verb자원에 대한 행위HTTP Method
Reprsentations자원에 대한 행위의 내용HTTP Message Pay Load

REST API의 Example

json-server

  • json-server 를 사용하여 REST API를 사용

GET

  • json 데이터 리소스에서 모든 데이터를 조회함
  • id를 사용하여 특정 리소스를 조회 (retrieve)한다.

POST

  • json 데이터 리소스에서 새로운 데이터를 생성한다

PUT

  • 특정 리소스의 전체를 갱신할 때 사용, id를 사용하여 특정 id를 제외한 리소스 전체를 갱신한다

DELETE

  • id를 사용하여 특정 리소스를 삭제한다.

REF

promiseweb

profile
냠소현 개발일지

0개의 댓글