REST API의 구성

구성 요소 내용 표현 방법
자원 resource 자원 URI(엔드포인트)
행위 verb 자원에 대한 행위 HTTP 요청 메서드
표현 representations 자원에 대한 행위에 대한 구체적 내용 페이로드

REST API 설계 원칙

  1. URI는 리소스를 표현해야 한다

    # bad
    GET /getTodos/1
    GET /todos/show/1
    
    # good
    GET /todos/1
    
  2. 리소스에 대한 행위는 HTTP 요청 메서드로 표현한다

    HTTP 요청 메서드 종류 목적 페이로드
    GET index/retrieve 모든/특정 리소스 취득 X
    POST create 리소스 생성 O
    PUT replace 리소스의 전체 교체 O
    PATCH modify 리소스의 일부 수정 O
    DELETE delete 모든/특정 리소스 삭제 X
    # bad
    GET /todos/delete/1
    
    # good
    DELETE /todos/1
    

JSON Server를 이용한 REST API 실습

JSON Server 설치