FastAPI学习笔记(一)-7.查询参数及验证

一、查询参数及验证

'''
@author:invoker
@project:fastapi202108
@file: chapter032.py
@contact:invoker2021@126.com
@descript:
@Date:2021/8/6 7:40
@version: Python 3.7.8
'''
from fastapi import APIRouter, Query
from typing import Optional, List

app032 = APIRouter()

"""
3.2 查询参数及字符串验证
"""


# 1.有默认值表示参数为非必填项
@app032.get('/query')
def page_limit(page: int, limit: Optional[int] = None):
    if limit:
        return {"page": page, "limit": limit}
    return {"page": page}


fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}]
print(fake_items_db[0:10])

list1 = [1, 2, 3, 4, 5]
print(list1[0:10])


# 说明切片的尾值可以大于List的长度


@app032.get("/items/")
async def read_item(skip: int = 0, limit: int = 10):
    return fake_items_db[skip: skip + limit]


# 2.查询参数为bool时的自动转换
# 在url中输入以下，都会转化成True
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=yes
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=1
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=on

# 在url中输入以下，都会转化成False
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=no
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=0
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=off

# 在url中输入其他，都会报错
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=2
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=hello
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=offset

@app032.get("/query/bool/convert")
async def type_convert(param: bool = False):
    return param


# 3.查询参数的验证
# 3.1第一个参数没有给default值，所以为必填参数，且必须是a开头,长度7-18位的字符串
# 3.2第二个参数给了default值，所以为非必填参数
@app032.get('/query/validations')
def query_param_validate(
        value: str = Query(..., min_length=7, max_length=18, regex='^a'),
        values: List[str] = Query(default=['d1', 'd2'], alias="别名1")
):
    return value, values

1.1非路径参数，且为普通类型（int,str,bool,float）的均为查询参数

1.2 有默认值的查询参数均为选填项

1.3 没有默认值的查询参数均为必填项

# 1.有默认值表示参数为非必填项
@app032.get('/query')
def page_limit(page: int, limit: Optional[int] = None):
    if limit:
        return {"page": page, "limit": limit}
    return {"page": page}

在线接口文档及执行结果：

 

 

 

1.4 bool类型的查询参数，可以自动转换

# 2.查询参数为bool时的自动转换
# 在url中输入以下，都会转化成True
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=yes
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=1
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=on

# 在url中输入以下，都会转化成False
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=no
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=0
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=off

# 在url中输入其他，都会报错
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=2
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=hello
# http://127.0.0.1:8000/chapter032/query/bool/convert?param=offset

@app032.get("/query/bool/convert")
async def type_convert(param: bool = False):
    return param

1.5 查询阐述的验证，使用Query类，default值设置后，则对应的变量参数为选填。

# 3.查询参数的验证
# 3.1第一个参数没有给default值，所以为必填参数，且必须是a开头,长度7-18位的字符串
# 3.2第二个参数给了default值，所以为非必填参数
@app032.get('/query/validations')
def query_param_validate(
        value: str = Query(..., min_length=7, max_length=18, regex='^a'),
        values: List[str] = Query(default=['d1', 'd2'], alias="别名1")
):
    return value, values

在线接口文档及执行结果：