路径参数
你可以声明一个路径参数或者变量,使用python格式的字符串。
@app.get("/items/{item_id}")
async def read_item(item_id):
...
这个路径参数item_id的值将会传入函数中的变量item_id 中
使用类型的路径参数
你可以在函数中声明路径参数的类型,使用python类型注释。
...
async def read_item(item_id: int):
...
在此,item_id被声明为int类型。
数据转换:会将路径的字符串类型转换为int类型
数据验证:
如果在路径中输入非int字符,将导致error
{
"detail": [
{
"loc": [
"path",
"item_id"
],
"msg": "value is not a valid integer",
"type": "type_error.integer"
}
]
}
Pydantic
所有的数据验证都是基于pydantic实现的。
你也可以使用同样的类型声明在str,float,bool和许多其他负载的数据类型中。
顺序问题
当你创建一个操作路径的时候,这个路径就是固定的。
就像 /users/me,获取当前用户
然后你也可以使用/users/{user_id}去获得某个用户的数据。
但是因为这个路径是绝对顺序的,你必须得确保这个/users/me在/users/{user_id}之前被声明。
from fastapi import FastAPI
app = FastAPI()
@app.get("/users/me")
async def read_user_me():
return {"user_id": "the current user"}
@app.get("/users/{user_id}")
async def read_user(user_id: str):
return {"user_id": user_id}
预定义值
如果你想在路径参数中使用预定义值,可以使用标准的python enum。
1、创建enum 类
导入enum 并且创建一个子类继承自str和enum
继承自str是为了api文档能够知道这个值得类型为string。
然后创建类属性为固定值,这些值就是预定义的可用值。
eg:
from enum import Enum
class ModelName(str,Enum):
alexnet="alexnet"
resnet="resnet"
lenet="lenet"
2、声明路径参数
创建一个路径参数并类型注释为你所创建的ModelName
@app.get('/model/{model_name}')
async def get_model(model_name: ModelName):
if model_name == ModelName.alexnet:
return {"model_name": model_name, "message": "Deep Learning FTW!"}
if model_name.value == "lenet":
return {"model_name": model_name, "message": "LeCNN all the images"}
return {"model_name": model_name, "message": "Have some residuals"}
路径参数中包含路径
如果路径使用/files/{file_path}
但是file_path中包含路径,就像:home/johndoe/myfile.txt
所以整个完整得路径就是:/files/home/johndoe/myfile.txt
openapi 中并不支持这种方式,但是在fastapi中可以使用从starlette中来的一个工具,并且docs也能正常的工作
可以这样声明:
/files/{file_path:path}
from fastapi import FastAPI
app = FastAPI()
@app.get("/files/{file_path:path}")
async def read_user_me(file_path: str):
return {"file_path": file_path}**