[파이썬][Django] RESTful API 디자인 원칙은? 그리고 예제

29 Aug 2023

django

RESTful API 디자인은 웹 API를 설계하는 일련의 원칙을 따르는 것입니다. 아래는 RESTful API 디자인의 주요 원칙과 간단한 예제를 제공합니다.

RESTful API 디자인 원칙

자원 (Resources): API의 주요 요소는 자원(데이터 레코드, 객체 등)입니다. 각 자원은 고유한 식별자(URI)를 가집니다.
표현 (Representation): 자원은 여러 표현 형태(JSON, XML, HTML 등)로 제공될 수 있습니다. 클라이언트는 표현을 요청할 수 있습니다.
URI(Uniform Resource Identifier): 자원은 고유한 URI를 가집니다. URI는 자원의 식별자로 사용됩니다.
HTTP 메서드: HTTP 메서드(GET, POST, PUT, DELETE 등)를 사용하여 자원을 조작합니다. 각 메서드는 특정 작업을 수행합니다.
상태 무상태 (Stateless): 각 요청은 모든 필요한 정보를 포함하고 있으며, 서버는 이전 요청에 대한 상태를 기억하지 않습니다.
HATEOAS (Hypermedia As The Engine Of Application State): 클라이언트는 API를 탐색하고 활용하기 위해 하이퍼링크를 사용합니다.

RESTful API 예제

이제 간단한 예제를 통해 RESTful API 디자인 원칙을 살펴보겠습니다. 예제 API는 간단한 작업 관리 시스템을 다루는 것으로 가정합니다.

자원 및 URI 정의:
- 작업 (Task) 자원: /tasks
- 특정 작업 (Task) 자원: /tasks/{task_id}
HTTP 메서드 및 작업:
- GET /tasks: 모든 작업 목록을 가져오기
- GET /tasks/{task_id}: 특정 작업 가져오기
- POST /tasks: 새 작업 만들기
- PUT /tasks/{task_id}: 특정 작업 업데이트
- DELETE /tasks/{task_id}: 특정 작업 삭제
표현 형태:
- JSON 형식을 사용하여 작업 정보를 표현합니다.
상태 무상태:

클라이언트가 모든 필요한 정보를 요청에 포함시켜야 합니다. 예를 들어, 작업을 생성할 때 작업의 모든 세부 정보를 요청에 포함시켜야 합니다.
HATEOAS:

작업 목록을 조회할 때 각 작업에 대한 링크를 포함하는 JSON 응답을 반환합니다.

{
    "tasks": [
        {
            "id": 1,
            "title": "할 일 1",
            "description": "첫 번째 할 일",
            "links": {
                "self": "/tasks/1"
            }
        },
        {
            "id": 2,
            "title": "할 일 2",
            "description": "두 번째 할 일",
            "links": {
                "self": "/tasks/2"
            }
        }
    ],
    "links": {
        "self": "/tasks",
        "create": "/tasks"
    }
}

이 예제에서는 작업 자원을 조회, 생성, 수정 및 삭제하기 위한 API를 설계하였습니다. 이러한 원칙을 따르면 API가 직관적이며 확장 가능하며 클라이언트가 쉽게 사용할 수 있게 됩니다.