본문 바로가기
Category/Note

RESTful API의 핵심 설계 원칙

by Corinee 2025. 3. 21.
728x90
반응형

REST는 자원 중심(Resource-Oriented) 이기 때문에,

URL은 "무엇을" 다루는지 (명사)를 표현하고,

HTTP 메서드(GET, POST 등)는 "어떻게" 처리할지를 표현해야 함.

잘못된 방식 (행위 중심)

GET /getItem
POST /createItem
DELETE /deleteItem?id=1
  • 메서드 이름을 URL에 표현하는 건 RESTful하지 않음
  • HTTP 메서드 자체가 이미 의미를 내포하고 있기 때문에 중복

바람직한 방식 (자원 중심)

GET /items           // 아이템 목록 조회
GET /items/123       // 특정 아이템 조회
POST /items          // 아이템 생성
PUT /items/123       // 아이템 수정
DELETE /items/123    // 아이템 삭제
          HTTP 메서드       URL              의미
GET /items 전체 목록 조회
GET /items/1 아이디 1번 아이템 조회
POST /items 아이템 생성
PUT /items/1 아이템 수정
DELETE /items/1 아이템 삭제

RESTful한 API 네이밍 규칙

          나쁜 예                        좋은 예 
/getUserList /users
/createOrder POST /orders
/updateProduct/1 PUT /products/1
/deleteComment?id=5 DELETE /comments/5