如何使用 FastAPI 允许 OpenAPI 规范（Swagger UI）中的特定参数值？ [复制]

我正在阅读有关的教程路径参数验证.

我想允许字符串“a”“b”和“c”作为可能的参数值。我希望这些值显示在 OpenAPI 文档中（即FastAPI 的自动文档），这样 API 用户就不必猜测它们。如何使这些值显示在文档中？

这是我的实现：

from fastapi import FastAPI, HTTPException

app = FastAPI()

parameters = ["a", "b", "c"]

@app.get("/endpoint/{parameter}")
def endpoint(parameter: str):
    if parameter not in parameters:
        raise HTTPException(status_code=400, detail="parameter must be a, b, or c")
    return {"parameter": parameter}

Option 1

你可以使用enums，通过创建一个Enum子类，如中所述FastAPI文档:

from enum import Enum

class MyParam(str, Enum):
    a= "a"
    b= "b"
    c= "c"

@app.get("/{my_param}")
def index(my_param: MyParam):
    return {"my_param": my_param}

Option 2

或者，您可以使用Literaltype，它允许您指定参数只能接受特定的Literal values:

from typing import Literal

@app.get("/{my_param}")
def index(my_param: Literal["a", "b", "c"]):
    return {"my_param": my_param}