Python 플라스크 RESTful을 사용하는 방법

1. RESTful 개요

REST(Representational State Transfer) 스타일은 웹 애플리케이션이 우수한 가독성, 확장성 및 유지 관리성을 갖도록 몇 가지 디자인 원칙을 따르는 리소스 중심의 웹 애플리케이션 디자인 스타일입니다. RESTful 스타일의 각 측면을 자세히 설명하겠습니다.

• Resource Identifier: RESTful 스타일에서 각 리소스에는 일반적으로 URL(Uniform Resource Locator)과 같은 고유 식별자가 있습니다. URL은 클라이언트가 HTTP 프로토콜을 사용하여 리소스에 액세스할 수 있도록 리소스의 위치를 ​​식별하는 데 사용됩니다. 예를 들어, 단순 URL은 http://example.com/products/123일 수 있습니다. 여기서 "products"는 리소스 유형을 나타내고 "123"은 는 리소스 식별자를 나타냅니다. URL（Uniform Resource Locator）。URL 用于标识资源的位置，使得客户端可以使用 HTTP 协议进行访问。例如，一个简单的 URL 可以是：http://example.com/products/123，其中“products”表示资源类型，“123”表示资源标识符。

• 表示层：资源可以以不同的格式表示，例如 JSON，XML，HTML 等。客户端可以根据需要选择适当的表示形式进行交互。例如，一个 RESTful API 可以返回 JSON 格式的数据，以便客户端可以更容易地解析和处理数据。

• 自描述消息：每个消息都应该包含足够的信息，以描述如何处理该消息。例如，HTTP 响应应该包含状态码、响应头和响应正文等信息，以便客户端可以理解响应的含义。

• 无状态通信：RESTful 风格的设计强调无状态通信，这意味着每个请求都应该包含所有必要的信息以处理该请求，而不依赖于先前的请求。这可以使得 Web 应用程序更加简单和可扩展，因为服务器不需要保留任何状态信息。

• 统一接口：所有资源应该通过相同的接口来访问。这意味着客户端可以使用相同的 HTTP 方法（如 GET、POST、PUT、DELETE 等）来操作不同类型的资源。这使得 API 更加简单和一致，并且更容易被其他开发者理解和使用。

总之，RESTful 风格的设计使得 Web 应用程序更加灵活、可扩展和易于维护，是一种现代化的 Web 应用程序设计方式。

二、Python 中的 RESTful

Python 可以用于实现 RESTful 风格的 Web 应用程序，通常使用一些 Web 框架来简化开发过程。下面是一些常见的 Python Web 框架：

• Flask：Flask 是一个简单、轻量级的 Web 框架，可以用来构建 RESTful 风格的 Web 应用程序。它使用 Python 的装饰器语法来定义 HTTP 路由，使得编写 Web 应用程序变得简单和直观。Flask 还提供了扩展机制，使得开发人员可以轻松地添加新的功能，例如数据库访问、表单验证等。

• Django：Django 是一个功能强大、全面的 Web 框架，可以用于构建复杂的 Web 应用程序。它提供了许多内置功能，例如 ORM（对象关系映射）、表单验证、身份验证等，可以使开发人员更快地构建 Web 应用程序。Django 也支持 RESTful 风格的 Web 应用程序开发，可以使用第三方库 Django REST framework 来实现。

• Bottle：Bottle 是一个轻量级的 Web 框架，它使用 Python 的装饰器语法来定义 HTTP 路由，可以快速构建 RESTful 风格的 Web 应用程序。Bottle 还包含了一些有用的功能，例如模板引擎、数据库访问、静态文件处理等。

• Pyramid：Pyramid 是一个灵活、高度可定制的 Web 框架，可以用于构建各种类型的 Web 应用程序，包括 RESTful 风格的 Web 应用程序。Pyramid 提供了许多扩展机制，使得开发人员可以轻松地添加新的功能，例如数据库访问、表单验证、身份验证等。

以上框架都支持 RESTful 风格的 Web 应用程序开发，并且都具有各自的优缺点，开发人员可以根据自己的需求选择合适的框架。

三、Flask RESTful API 示例讲解

1）Flask-RESTful 库讲解

Flask-RESTful 是一个基于 Flask 的扩展库，它提供了一些方便的工具来构建 RESTful API。下面是 Flask-RESTful 的一些主要特点和功能：

• 资源类：Flask-RESTful 提供了一个 Resource 基类，可以用来创建资源。Resource 类包含了 HTTP 方法（GET、POST、PUT、DELETE

🎜🎜프레젠테이션 레이어🎜: 리소스는 JSON, XML, HTML 등과 같은 다양한 형식으로 표현될 수 있습니다. . 고객은 필요에 따라 상호 작용할 적절한 표현을 선택할 수 있습니다. 예를 들어 RESTful API는 클라이언트가 데이터를 더 쉽게 구문 분석하고 처리할 수 있도록 JSON 형식으로 데이터를 반환할 수 있습니다. 🎜🎜🎜🎜자체 설명 메시지🎜: 각 메시지에는 메시지 처리 방법을 설명하는 데 충분한 정보가 포함되어야 합니다. 예를 들어 HTTP 응답에는 클라이언트가 응답의 의미를 이해할 수 있도록 상태 코드, 응답 헤더, 응답 본문 등의 정보가 포함되어야 합니다. 🎜🎜🎜🎜상태 없는 통신🎜: RESTful 스타일 디자인은 상태 없는 통신을 강조합니다. 즉, 각 요청에는 이전 요청에 의존하지 않고 요청을 처리하는 데 필요한 모든 정보가 포함되어야 합니다. 서버가 상태 정보를 유지할 필요가 없기 때문에 웹 애플리케이션을 더 간단하고 확장 가능하게 만들 수 있습니다. 🎜🎜🎜🎜통합 인터페이스🎜: 모든 리소스는 동일한 인터페이스를 통해 액세스해야 합니다. 이는 클라이언트가 동일한 HTTP 메소드(예: GET, POST, PUT, DELETE 등)를 사용할 수 있음을 의미합니다. .) 다양한 유형의 자원을 운영합니다. 이는 API를 더욱 단순하고 일관되게 만들고 다른 개발자가 이해하고 사용하기 쉽게 만듭니다. 🎜

🎜간단히 말하면, RESTful 스타일 디자인은 웹 애플리케이션을 더욱 유연하고 확장 가능하며 유지 관리하기 쉽게 만들고 웹 애플리케이션을 디자인하는 현대적인 방식입니다. 🎜🎜2. Python의 RESTful🎜🎜Python은 일반적으로 개발 프로세스를 단순화하기 위해 일부 웹 프레임워크를 사용하여 RESTful 스타일 웹 애플리케이션을 구현하는 데 사용할 수 있습니다. 다음은 몇 가지 일반적인 Python 웹 프레임워크입니다. 🎜🎜🎜🎜Flask: Flask는 RESTful 스타일 웹 애플리케이션 프로그램을 구축하는 데 사용할 수 있는 간단하고 가벼운 웹 프레임워크입니다. . Python의 데코레이터 구문을 사용하여 HTTP 경로를 정의함으로써 웹 애플리케이션 작성을 간단하고 직관적으로 만듭니다. Flask는 또한 개발자가 데이터베이스 액세스, 양식 유효성 검사 등과 같은 새로운 기능을 쉽게 추가할 수 있도록 확장 메커니즘을 제공합니다. 🎜🎜🎜Django: Django는 복잡한 웹 애플리케이션을 구축하는 데 사용할 수 있는 강력하고 포괄적인 웹 프레임워크입니다. 개발자가 웹 애플리케이션을 더 빠르게 구축할 수 있도록 하는 ORM(객체 관계형 매핑), 양식 유효성 검사, 인증 등과 같은 다양한 내장 기능을 제공합니다. Django는 또한 타사 라이브러리 Django REST 프레임워크를 사용하여 구현할 수 있는 RESTful 스타일 웹 애플리케이션 개발을 지원합니다. 🎜🎜🎜Bottle: Bottle은 Python의 데코레이터 구문을 사용하여 HTTP 경로를 정의하고 RESTful 스타일 웹 애플리케이션을 빠르게 구축할 수 있는 경량 웹 프레임워크입니다. Bottle에는 템플릿 엔진, 데이터베이스 액세스, 정적 파일 처리 등과 같은 몇 가지 유용한 기능도 포함되어 있습니다. 🎜🎜🎜Pyramid: Pyramid는 RESTful 스타일 웹 애플리케이션을 포함하여 다양한 유형의 웹 애플리케이션을 구축하는 데 사용할 수 있는 유연하고 사용자 정의가 가능한 웹 프레임워크입니다. Pyramid는 개발자가 데이터베이스 액세스, 양식 유효성 검사, 인증 등과 같은 새로운 기능을 쉽게 추가할 수 있는 다양한 확장 메커니즘을 제공합니다. 🎜🎜위 프레임워크는 모두 RESTful 스타일의 웹 애플리케이션 개발을 지원하며 모두 고유한 장점과 단점이 있습니다. 개발자는 자신의 필요에 따라 적절한 프레임워크를 선택할 수 있습니다. 🎜🎜3. Flask RESTful API 예시 설명🎜

1) Flask-RESTful 라이브러리 설명

🎜Flask-RESTful은 Flask 기반의 확장 라이브러리로 RESTful API를 구축할 수 있는 몇 가지 편리한 도구를 제공합니다. Flask-RESTful의 주요 기능은 다음과 같습니다. 🎜🎜🎜🎜🎜Resource Class🎜: Flask-RESTful은 리소스를 생성하는 데 사용할 수 있는 Resource 기본 클래스를 제공합니다. Resource 클래스에는 HTTP 메서드(GET, POST, PUT, DELETE 등)의 처리 논리가 포함되어 있습니다. 요청 및 응답을 처리하기 위한 몇 가지 편리한 방법을 제공합니다. 🎜

요청 매개변수 구문 분석: Flask-RESTful은 요청 매개변수 구문 분석을 위한 RequestParser 클래스를 제공합니다. RequestParser는 쿼리 매개변수, 양식 매개변수, JSON 매개변수 등을 자동으로 Python 유형으로 구문 분석할 수 있으며 매개변수 유형, 기본값, 존재 여부 및 기타 제한 사항을 지정하는 몇 가지 옵션을 제공합니다. RequestParser 类，用于解析请求参数。RequestParser 可以自动将查询参数、表单参数、JSON 参数等解析成 Python 类型，并提供了一些选项来指定参数的类型、默认值、必须存在等限制条件。

响应格式化：Flask-RESTful 提供了一个 marshal_with() 装饰器，用于格式化响应数据。marshal_with() 装饰器可以将 Python 对象转换成指定的输出格式（如 JSON、XML 等），并支持指定输出字段、字段类型、嵌套字段等功能。

路由定义： Flask-RESTful 提供了一个 Api 类，用于定义路由和资源的映射关系。Api 类包含了 add_resource()方法，用于将资源类和 URL 路由绑定起来。

异常处理：Flask-RESTful 提供了一些异常类，用于处理 HTTP 请求和响应中的错误。Flask-RESTful 的异常类包括 abort、HTTPException 等，可以方便地处理 HTTP 状态码、错误信息等。

综上所述，Flask-RESTful 提供了一些方便的工具来简化 RESTful API 的开发。使用 Flask-RESTful 可以快速地定义资源、解析请求参数、格式化响应数据、定义路由和处理异常等，从而提高开发效率并降低出错的风险。

2）Flask-RESTful 库安装

要安装 Flask-RESTful 库，可以使用 pip 命令进行安装。在终端中执行以下命令：

pip3 install flask-restful

这将会从 PyPI 上下载 Flask-RESTful 库，并安装到本地的 Python 环境中。安装完成后，就可以在代码中导入 flask_restful 模块，使用 Flask-RESTful 提供的功能来构建 RESTful API。

3）RESTful 示例讲解

下面是一个简单的 Flask RESTful API 示例，它实现了一个简单的 To-Do List 应用程序：

from flask import Flask, request
from flask_restful import Api, Resource, reqparse, fields, marshal_with
app = Flask(__name__)
api = Api(app)
todos = {}
todo_fields = {
    'id': fields.Integer,
    'task': fields.String,
    'status': fields.Boolean
}
class TodoList(Resource):
    @marshal_with(todo_fields)
    def get(self):
        return todos
    @marshal_with(todo_fields)
    def post(self):
        parser = reqparse.RequestParser()
        parser.add_argument('task', type=str, help='Task is required', required=True)
        args = parser.parse_args()
        todo_id = len(todos) + 1
        todo = {'task': args['task'], 'status': False}
        todos[todo_id] = todo
        return todo, 201
class TodoItem(Resource):
    @marshal_with(todo_fields)
    def get(self, todo_id):
        return todos[todo_id]
    def put(self, todo_id):
        parser = reqparse.RequestParser()
        parser.add_argument('task', type=str)
        parser.add_argument('status', type=bool)
        args = parser.parse_args()
        todo = todos[todo_id]
        if args['task']:
            todo['task'] = args['task']
        if args['status']:
            todo['status'] = args['status']
        return todo
    def delete(self, todo_id):
        del todos[todo_id]
        return '', 204
api.add_resource(TodoList, '/todos')
api.add_resource(TodoItem, &#39;/todos/<int:todo_id>&#39;)
if __name__ == &#39;__main__&#39;:
    app.run(debug=True)

启动

# 配置环境变量
export FLASK_APP=restful-test.py
# 启动服务，公开访问需要加上--host=0.0.0.0
python -m flask run --host=0.0.0.0

该示例使用 Flask 和 Flask-RESTful 库来实现 To-Do List 应用程序的 RESTful API。下面是一些重要的代码片段的解释：

• 定义资源：在示例中，有两个资源：TodoList 和 TodoItem。TodoList 用于处理所有的 To-Do 任务列表，TodoItem 用于处理单个任务。

• 定义请求参数：在示例中，我们使用 Flask-RESTful 库的 RequestParser 来解析请求参数。我们定义了 'task' 和 'status' 参数，并使用 add_argument() 方法来指定它们的类型和其他限制条件。

• 定义响应格式：在示例中，我们使用 Flask-RESTful 库的 marshal_with() 装饰器来定义响应的格式。我们定义了一个名为 todo_fields 的字典，其中包含了 To-Do 任务的 id、task 和 status 字段。

• 定义请求方法：在示例中，我们使用 Flask-RESTful 库的 Resource 类来定义请求方法。我们实现了 GET、POST、PUT 和 DELETE 方法，用于获取任务列表、添加任务、更新任务和删除任务。

• 添加路由：在示例中，我们使用 Flask-RESTful 库的 Api 类来添加路由。我们使用 add_resource()

응답 형식화: Flask-RESTful은 응답 데이터 형식화를 위한 marshal_with() 데코레이터를 제공합니다. marshal_with() 데코레이터는 Python 객체를 지정된 출력 형식(예: JSON, XML 등)으로 변환할 수 있으며 출력 필드, 필드 유형, 중첩 필드 지정 등과 같은 기능을 지원합니다.

경로 정의

: Flask-RESTful은 경로와 리소스 간의 매핑 관계를 정의하기 위한 Api 클래스를 제공합니다. Api 클래스에는 리소스 클래스와 URL 경로를 바인딩하는 데 사용되는 add_resource() 메서드가 포함되어 있습니다.

예외 처리: Flask-RESTful은 HTTP 요청 및 응답의 오류를 처리하기 위한 몇 가지 예외 클래스를 제공합니다. Flask-RESTful의 예외 클래스에는 abort, HTTPException 등이 포함되어 있어 HTTP 상태 코드

,

오류 메시지 등을 쉽게 처리할 수 있습니다.

요약하자면 Flask-RESTful은 RESTful API 개발을 단순화하는 몇 가지 편리한 도구를 제공합니다. Flask-RESTful을 사용하면 신속하게 리소스 정의, 요청 매개변수 구문 분석, 응답 데이터 형식 지정, 경로 정의, 예외 처리 등을 수행할 수 있으므로 개발 효율성이 향상되고 오류 위험이 줄어듭니다.

2) Flask-RESTful 라이브러리 설치

🎜Flask-RESTful 라이브러리를 설치하려면 pip 명령을 사용하여 설치할 수 있습니다. 터미널에서 다음 명령을 실행하세요: 🎜

# GET http://localhost:5000/todos
curl http://localhost:5000/todos

🎜이렇게 하면 PyPI에서 Flask-RESTful 라이브러리가 다운로드되어 로컬 Python 환경에 설치됩니다. 설치가 완료되면 flask_restful 모듈을 코드로 가져오고 Flask-RESTful에서 제공하는 기능을 사용하여 RESTful API를 구축할 수 있습니다. 🎜

3) RESTful 예제 설명

🎜다음은 간단한 To-Do List 애플리케이션을 구현하는 간단한 Flask RESTful API 예제입니다. 🎜

# POST http://localhost:5000/todos
curl -XPOST http://localhost:5000/todos -d 'task=123'
curl -XPOST http://localhost:5000/todos -d '{"task":"456"}'  --header "Content-Type: application/json"

🎜Start🎜

# GET http://localhost:5000/todos/1
curl http://localhost:5000/todos/1

🎜이 예제에서는 Flask 및 Flask -RESTful 라이브러리를 사용합니다. To-Do List 애플리케이션을 위한 RESTful API를 구현합니다. 다음은 몇 가지 중요한 코드 조각에 대한 설명입니다. 🎜

🎜🎜🎜리소스 정의🎜: 이 예에는 TodoList 및 TodoItem이라는 두 가지 리소스가 있습니다. . TodoList는 모든 To-Do 작업 목록을 처리하는 데 사용되며 TodoItem은 단일 작업을 처리하는 데 사용됩니다. 🎜🎜🎜🎜🎜요청 매개변수 정의🎜: 이 예에서는 Flask-RESTful 라이브러리의 RequestParser를 사용하여 요청 매개변수를 구문 분석합니다. 'task' 및 'status' 매개변수를 정의하고 add_argument() 메서드를 사용하여 해당 유형과 기타 제약 조건을 지정합니다. 🎜🎜🎜🎜🎜응답 형식 정의🎜: 예제에서는 Flask-RESTful 라이브러리의 marshal_with() 데코레이터를 사용하여 응답 형식을 정의합니다. To-Do 작업의 id, task 및 status를 포함하는 todo_fields라는 사전을 정의합니다. 필드. 🎜🎜🎜🎜🎜요청 방법 정의🎜: 이 예에서는 Flask-RESTful 라이브러리의 Resource 클래스를 사용하여 요청 방법을 정의합니다. 🎜작업 목록 가져오기🎜 및 🎜추가를 위한 GET, POST, PUT 및 DELETE 메서드를 구현했습니다. 작업 🎜, 🎜작업 업데이트🎜 및 🎜작업 삭제🎜. 🎜🎜🎜🎜🎜경로 추가🎜: 이 예에서는 Flask-RESTful 라이브러리의 Api 클래스를 사용하여 경로를 추가합니다. add_resource() 메서드를 사용하여 TodoList 및 TodoItem 클래스를 해당 URL 경로와 바인딩합니다. 🎜🎜🎜🎜예제를 실행한 후 URL에 접속하면 To-Do List 애플리케이션의 RESTful API를 사용할 수 있습니다. 예를 들어, 🎜모든 작업 목록을 가져오려면🎜 다음 URL을 사용할 수 있습니다: 🎜

# PUT http://localhost:5000/todos/1
curl -XPUT http://localhost:5000/todos/1 -d '{"task":"test"}'  --header "Content-Type: application/json"
# 查看
curl http://localhost:5000/todos/1

🎜 🎜새 작업을 추가🎜하려면 다음 URL을 사용할 수 있습니다: 🎜

# DELETE http://localhost:5000/todos/1
curl -XDELETE http://localhost:5000/todos/1

🎜 🎜단일 작업을 가져오려면🎜 다음 URL을 사용할 수 있습니다: 🎜rrreee🎜 🎜작업을 업데이트하려면🎜 다음 URL을 사용할 수 있습니다: 🎜rrreee🎜 🎜작업을 삭제🎜하려면 다음 URL을 사용할 수 있습니다: 🎜rrreee🎜🎜🎜

위 내용은 Python 플라스크 RESTful을 사용하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!