如何使用FastAPI和Swagger允许任意查询参数？

Question

注意：这个问题与这里的问题不同，因为我需要它来处理Swagger。

给定一个 FastAPI GET endpoint，我想允许任意一组 URL 参数，同时保持 Swagger 支持。

我的用例是，我想支持一组类似JSON API的查询参数，例如：

/api/books/?include=author&sort=name,zip&sort[author]=-lname&fields=name,phone,street

方括号的使用阻止了我使用传统的类来建模查询参数，所以我直接使用请求对象来代替。但是，我想使用Swagger来测试endpoint。我找不到提供任意URL参数的方法。我很乐意将它们作为单个字符串输入。

人们可能会这样想:

def books(**params): 
    ....

这给出了一个curl语句：

api/books?params=sort%5Bone%5D%3Dtwo'

我真正想要的是：

api/books?sort&one%5D%3Dtwo'

Answer 1

您可以使用可选字符串参数（book_params在下面的情况下）通过OpenAPI（Swagger UI）将查询参数作为单个字符串传递，例如，包括=作者

下面的示例还使用了这里描述的方法，以修复parse_qs将单个值解析为列表的部分（例如，“foo=bar”将解析为 用户在url中多次传递同一个键，即 'fo=2

您可以检查这个可选参数，即book_params是否为空，以决定是使用book_params（意味着请求通过Swagger发送）还是直接使用请求对象（意味着通过在浏览器的地址栏中键入URL发送请求，例如，http://127.0.0.1:8000/api/books?include=author

from fastapi import FastAPI, Request
from typing import Optional
from urllib.parse import parse_qs

app = FastAPI()

@app.get("/api/books")
def books(request: Request, book_params: Optional[str] = None):
    q_params = {}
    
    if book_params is not None:
        q_params = parse_qs(book_params, keep_blank_values=True)
    else:   
        q_params = parse_qs(request.url.query, keep_blank_values=True)
        
    d = dict((k, v if len(v)>1 else v[0]) 
                for k, v in q_params.items())

    return d