Path Parameters

python

发布日期: 2020-04-10

文章字数: 629

阅读时长: 2 分

阅读次数:

path 中可以用 python 格式字符串的形式来声明变量，例如

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_item(item_id):
    return {"item_id": item_id}

变量 item_id 会成为为函数的一个参数

带类型的路径变量

from fastapi import FastAPI

app = FastAPI()


@app.get("/items/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id}

给路径变量添加类型：

有助于 IDE 的检查和代码自动补全
FastAPI 可以根据声明的类型对变量自动解析 (将从http请求获得的字符串转化为 python data)
- 例如向 http://127.0.0.1:8000/items/3 发送请求会得到 {"item_id":3} 其中 3 是 python 整型变量

FastAPI 可以根据声明的类型对数据进行验证，例如访问 http://127.0.0.1:8000/items/foo 会得到如下错误

{
    "detail": [
        {
            "loc": [
                "path",
                "item_id"
            ],
            "msg": "value is not a valid integer",
            "type": "type_error.integer"
        }
    ]
}

Pydantic

所有的数据验证工作都是由 Pydantic 提供的

路径顺序

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}

如果用 /users/me 表示当前用户 /users/{user_id} 表示特定用户，则 /users/me 需要放在前面，在 fastapi 中路径是按照声明的顺序来依次匹配的

Predefined values

如果希望接收到预先定义的合法路径变量，可以使用 Enum

from enum import Enum

from fastapi import FastAPI


# 继承自 str 相当于给每一个属性声明 str 类型
class ModelName(str, Enum):
    alexnet = "alexnet"
    resnet = "resnet"
    lenet = "lenet"


app = FastAPI()


@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"}

包含路径的路径变量

OpenAPI 不支持包含路径变量中包含路径，但是 FastAPI 借助 Starlette 的内置工具可以实现，并且生成的 API 文档仍然可用

from fastapi import FastAPI

app = FastAPI()


@app.get("/files/{file_path:path}")
async def read_file(file_path: str):
    return {"file_path": file_path}