APIFlask
Le Wed 12 February 2025
主页: https://apiflask.com GitHub: https://github.com/greyli/apiflask
APIFlask 在 Flask 的基础上添加了更多 Web API 相关的功能支持，核心特性包括：
更多方便的装饰器，比如 @app.input()、@app.output()、@app.get()、@app.post() 等等 自动反序列化和验证请求格式，当请求数据不符合模式类要求时，会自动生成包含错误详细信息的错误响应（基于 Webargs） 自动格式化和序列化响应数据，在定义好响应模式后，你可以直接在视图函数返回一个模型类对象，或是返回字典（基于 Marshmallow） 自动生成 OpenAPI Specification 文件，你可以把这个文件导入到 API 调试工具或是用来生成客户端代码（基于 APISpec） 自动生成交互式 API 文档，并自动为蓝本和视图设置对应的标签分类（基于 Swagger UI and Redoc） 自动为 HTTP 错误生成 JSON 格式的错误响应 下面是一个最基础的示例程序：
from apiflask import APIFlask, Schema, abort
from apiflask.fields import Integer, String
from apiflask.validators import Length, OneOf
app = APIFlask(__name__) # 可以使用 title 和 version 参数来自定义 API 的名称和版本
pets = [
{
'id': 0,
'name': 'Kitty',
'category': 'cat'
},
{
'id': 1,
'name': 'Coco',
'category': 'dog'
}
]
# 定义一个请求数据模式类
class PetInSchema(Schema):
name = String(required=True, validate=Length(0, 10)) # 可以使用 description 参数添加字段描述
category = String(required=True, validate=OneOf(['dog', 'cat']))
# 定义一个响应数据模式类
class PetOutSchema(Schema):
id = Integer()
name = String()
category = String()
@app.get('/pets/<int:pet_id>')
@app.output(PetOutSchema) # 使用 @output 装饰器标记响应数据模式
def get_pet(pet_id):
if pet_id > len(pets) - 1:
abort(404)
# 在真实程序里，你可以直接返回 ORM 模型类的实例，比如
# return Pet.query.get(1)
return pets[pet_id]
@app.patch('/pets/<int:pet_id>')
@app.input(PetInSchema(partial=True)) # 使用 @input 装饰器标记请求数据模式
@app.output(PetOutSchema)
def update_pet(pet_id, json_data): # 通过验证后的请求数据字典会注入到视图函数，默认参数名为 json_data
if pet_id > len(pets) - 1:
abort(404)
for attr, value in json_data.items():
pets[pet_id][attr] = value
return pets[pet_id]
pip install apiflask
APIFlask 只在 Flask 之上做了轻量级包装，所以你实际上仍然是在写一个 Flask 程序，所有 Flask 的特性都完全兼容。你只需要记住下面两处不同点：
创建程序实例的时候使用 APIFlask 类（from apiflask import APIFlask）。 创建蓝本实例的时候使用 APIBlueprint 类（from apiflask import APIBlueprint）。 使用 apiflask.abort() 函数返回 JSON 格式的错误响应。
from flask import Flask, request, escape
app = Flask(__name__)
@app.route('/')
def hello():
name = request.args.get('name', 'Human')
return f'Hello, {escape(name)}'
迁移到 APIFlask 只需要改动两行代码：
from apiflask import APIFlask # 第一行
from flask import request, escape
app = APIFlask(__name__) # 第二行
@app.route('/')
def hello():
name = request.args.get('name', 'Human')
return f'Hello, {escape(name)}'