Flask-Pydantic官方文档：https://github.com/bauerji/flask-pydantic#basic-example

python类型注释的数据校验和设置管理
pydantic在运行时强制执行类型提示，并在数据无效时提供友好的错误
换句话说，pydantic保证输出模型的类型和约束，而不是输入数据
在pydantic中定义对象的主要方法是通过继承自BaseModel类的模型
pydantic官方文档：https://pydantic-docs.helpmanual.io/

安装

  1. pip3 install Flask-Pydantic

URL路径参数（Query请求参数）

其中get方法中的query参数相当于解析request对象query_params属性获得的参数

  2. from flask import jsonify, make_response, request
  3. from flask_restful import Resource, abort
  4. from logzero import logger
  5. from utils.app import DB
  6. from flask_pydantic import validate
  7. from pydantic import BaseModel
  8. from typing import Optional
  11. class QueryModel(BaseModel):
  12.     """路径参数模型"""
  13.     index: int
  15. class ResponseModel(BaseModel):
  16.     """响应参数模型"""
  17.     id: int
  18.     index: int
  19.     nickname: Optional[str]
  21. class RequestBodyModel(BaseModel):
  22.     """请求体模型"""
  23.     name: str
  24.     nickname: Optional[str]
  27. class PydanticApi(Resource):
  30.     @validate(response_many=True)
  31.     def get(self, query: QueryModel, body: RequestBodyModel, on_success_status=201):
  32.         """
  33.         query:解析请求参数，
  34.         body：解析请求体，
  35.         on_success_status： 控制请求成功的状态码，默认为200,
  36.         response_many参数设置为True可以序列化多个模型
  37.         """
  38.         return [
  39.             ResponseModel(
  40.                 id=0,
  41.                 index=query.index,
  42.                 nickname="zaygww"
  43.         ),
  44.             ResponseModel(
  45.                 id=2,
  46.                 index=query.index,
  47.                 nickname="zaygw"
  48.             )
  49.         ]
  51.     @validate(request_body_many=True)
  52.     def post(self, query: QueryModel, body: RequestBodyModel):
  53.         """
  54.         query:解析请求参数，
  55.         body：解析请求体，
  56.         on_success_status： 控制请求成功的状态码，默认为200,
  57.         response_many参数设置为True可以序列化多个模型
  58.         request_body_many参数设置为True可以以传入列表类型的请求参数
  59.         eg：
  60.                 [
  61.                 {
  62.                     "name": "name",
  63.                     "nickname": "nickname"
  64.                 },
  65.                 {
  66.                     "name": "name2",
  67.                     "nickname": "nickname2"
  68.                 },
  69.                 {
  70.                     "name": "name3",
  71.                     "nickname": "nickname3"
  72.                 }
  73.                 ]
  74.         """
  75.         # return RequestBodyModel(**request.body_params[request.query_params.index].dict())
  76.         logger.info(f"RequestBodyModel(**body[query.index].dict()): {RequestBodyModel(**body[query.index].dict())}")
  77.         return RequestBodyModel(**body[query.index].dict())
  79. """
  80. 请求：
  81. curl --location --request GET 'http://10.138.35.88:5000/pydantic_test?index=1' \
  82. --header 'User-Agent: Apipost client Runtime/+https://www.apipost.cn/' \
  83. --header 'Content-Type: application/json' \
  84. --data '
  85.     {
  86.         "name": "name",
  87.         "nickname": "nickname"
  88.     }
  89. '
  91. 响应结果：
  92. [{"id": 0, "index": 1, "nickname": "zaygww"}, {"id": 2, "index": 1, "nickname": "zaygw"}]
  93. """

Body请求体

上述例子get方法中的body参数相当于解析request对象body_params属性获得的参数
image.png

⚠️注意事项

  1. validate必须作为restful方法的第一个装饰器
  2. 该扩展目前只支持Content-Type = application/json的请求体，即不支持表单数据
  3. validate其他参数解析： ```python on_success_status：设置请求成功的状态码，默认为200 response_many参数设置为True可以序列化多个模型 request_body_many参数设置为True可以以传入列表类型的请求参数 FLASK_PYDANTIC_VALIDATION_ERROR_STATUS_CODE：设置validate装饰器验证失败的统一状态码 “”” eg:

from dataclasses import dataclass # 定义数据类

@dataclass class Config: FLASK_PYDANTIC_VALIDATION_ERROR_STATUS_CODE: int = 422

加载配置文件

app.config.from_object(Config) “”” ```