Python Flask 之 RESTful 讲解与示例演示-六虎

一、RESTful 概述

REST（Representational State Transfer）风格是一种面向资源的 Web 应用程序规划风格，它遵循一些规划准则，使得 Web 应用程序具有杰出的可读性、可扩展性和可维护性。下面咱们来具体解说一下 RESTful 风格的各个方面：

资源标识符：在 RESTful 风格中，每个资源都有一个唯一的标识符，通常是一个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 应用程序规划办法。

RESTful 官网：restfulapi.net/

二、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等）的处理逻辑，并供给了一些便利的办法来处理恳求和呼应。
恳求参数解析：Flask-RESTful 供给了一个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, '/todos/<int:todo_id>')
if __name__ == '__main__':
    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()办法来将 TodoList 和 TodoItem 类与相应的 URL 路由绑定起来。

在运转该示例后，能够经过拜访 URL 来运用 To-Do List 应用程序的 RESTful API。例如，要获取一切使命列表，能够运用以下 URL：

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

要增加一个新使命，能够运用以下 URL：

# 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"

要获取单个使命，能够运用以下 URL：

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

要更新使命，能够运用以下 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

总的来说，这个示例演示了如何运用 Flask-RESTful 来构建简略的 RESTful API，其中包含资源界说、恳求参数解析、呼应格局界说、恳求办法完成和路由增加等关键步骤。

Python Flask 之 RESTful 解说与示例演示就先到这里了，后续会持续更新相关技术文章，请小伙伴耐性等候，也可重视我的公众号【大数据与云原生技术分享】深入沟通技术或私信咨询问题~

Python Flask 之 RESTful 讲解与示例演示

一、RESTful 概述

二、Python 中的 RESTful

三、Flask RESTful API 示例解说

1）Flask-RESTful 库解说

2）Flask-RESTful 库装置

3）RESTful 示例解说

相关文章

yargs 库不完全指南

[Android] Handler 消息机制原理解析

Java 断言 assert 你真的会用嘛？

使用 Cursor 智能编辑器改进 React 官网井字棋游戏

作者信息