覆盖FastAPI中自动生成的参数

Question

我正在编写FastAPI程序，它只是一堆用于查询数据的@app.getendpoint。他们可以使用许多不同的查询参数，这些参数是从配置文件中自动生成的，例如@app.get（"/ADJUST_COLOR/"）endpoint可能看起来像/ADJUST_COLOR/？RED_darker=10

@app.get("/ADJUST_COLOR/")
def query_COLORS( request: Request ):
    return look_through_parameters(request.query_params) 

因为我是手动解析请求，所以没有生成任何参数。但是，由于我有一个完整的参数列表，所以我应该能够生成自己的文档并让UI显示它。

我翻看了这两个文档:https://fastapi . tiangolo . com/tutorial/path-operation-configuration/< br >和https://fastapi . tiangolo . com/advanced/path-operation-advanced-configuration/

但我不知道这是否可行




Answer 1

您可以通过openapi_extra在路由中定义自定义api架构（这是FastAPI的最新功能，0.68可以工作，但我不确定支持此功能的确切最早版本）：

@app.get("/ADJUST_COLOR/", openapi_extra={
    "parameters": [
        {
            "in": "query",
            "name": "RED_darker",
            "schema": {
                "type": "integer"
            },
            "description": "The level of RED_darker"
        },
        {
            "in": "query",
            "name": "BLUE_lighter",
            "schema": {
                "type": "integer"
            },
            "description": "The level of BLUE_lighter"
        },
        {
            "in": "query",
            "name": "GREEN_inverse",
            "schema": {
                "type": "boolean"
            },
            "description": "is GREEN_inverse?"
        },
    ]
})
async def query_COLORS(request: Request):
    return look_through_parameters(request.query_params)