FastAPI（6）- 详解 Query （下）-阿里云开发者社区

FastAPI（6）- 详解 Query （下）

2022-05-15 274

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： FastAPI（6）- 详解 Query （下）

添加正则表达式校验

# 正则表达式
@app.get("/items/regular")
async def read_items(
        name: Optional[str] = Query(
            default=None,
            min_length=3,
            max_length=10,
            regex="^小.*菠萝$"
        )):
    return {"name": name}

校验成功的请求结果

name 不满足正则，校验失败的请求结果

查看 Swagger API 文档

正则表达式教程

https://www.cnblogs.com/poloyy/category/1796055.html

必传参数+长度最小为 3

不使用 Query 时，查询参数怎么必传？

不指定默认值就行

name: str

当使用 Query 时，查询参数怎么必传？

Query 默认值参数 default 是必传的，传了默认值不就变成可选参数了吗，那怎么办呢？

# 必传参数

@app.get("/items/require")

async def read_items(name: Optional[str] = Query(default=..., max_length=10)):

return {"name": name}

只需要将 ... 赋值给 default 参数，FastAPI 就会知道这个参数是必传的

校验成功的请求结果

没有传必传参数，校验失败的请求结果

因为是必传参数，不传则报错！

查看 Swagger API 文档

大大的 required 标识！代表必传哦！

List 类型的查询参数

使用 Query 时，可以指定查询参数的类型为 List，即一个参数可以接收多个值

from typing import List
# List[str]
@app.get("/list")
async def read_item(address: Optional[List[str]] = Query([], max_length=2)):
    return {"address": address}

没有传参的请求结果

取 address 默认值 []

正确传参的请求结果

设置了校验 max_length=2，但传了三个 address 也正常，证明这个 max_length 的校验对数组长度并不生效

校验失败的请求结果

看来 max_length 校验仍然会对数组里面的字符串生效！

查看 Swagger API 文档

List 类型的查询参数有多个默认值

@app.get("/list/default")

async def read_item(address: Optional[List[str]] = Query(["广州", "深圳"])):

return {"address": address}

不传参的请求结果

元数据

Query 可以添加元数据相关信息，这些信息将包含在生成的 OpenAPI 中，并由文档用户界面和外部工具使用

四种元数据参数

# 别名
alias: Optional[str] = None
# 标题
title: Optional[str] = None
# 描述
description: Optional[str] = None
# 是否弃用
deprecated: Optional[bool] = None

实际代码

# 元数据
@app.get("/items/all")
async def read_items(
        name: Optional[str] = Query(
            default=None,
            min_length=2,
            max_length=50,
            regex="^菠萝$",
            alias="name_alias_query",
            title="标题",
            description="很长很长的描述",
            deprecated=True,
        )
):
    return {"name": name}