使用自定义路径参数添加到FastAPI的路由

Question

我正在尝试从文件中添加路由，但我事先不知道实际参数，因此我需要有一个通过**kwargs处理参数的通用函数。

要添加路线，我使用add_api_route，如下所示：

from fastapi import APIRouter

my_router = APIRouter()

def foo(xyz):
    return {"Result": xyz}

my_router.add_api_route('/foo/{xyz}', endpoint=foo)

以上工作正常。

但是enrty path参数不是固定的，我需要从文件中读取它们，为了实现这一点，我正在尝试这样的事情：

from fastapi import APIRouter

my_router = APIRouter()

def foo(**kwargs):
    return {"Result": kwargs['xyz']}

read_from_file = '/foo/{xyz}' # Assume this is read from a file

my_router.add_api_route(read_from_file, endpoint=foo)

但它抛出此错误：

{"detail":[{"loc":["query","kwargs"],"msg":"field required","type":"value_error.missing"}]}

FastAPI尝试在＜code＞foo＜/code＞签名中查找不存在的实际参数＜code＞xyz＜/code＞。

FastAPI中有什么方法可以实现这一点吗？或者任何接受像< code>/foo/这样的路径的解决方案...无论什么.../？

Answer 1

如下所述，您可以使用Starlette提供的path转换器来捕获任意路径。示例：

from fastapi import APIRouter, FastAPI

app = FastAPI()
my_router = APIRouter()

def foo(rest_of_path: str):
    return {"rest_of_path": rest_of_path}
    
route_path = '/foo/{rest_of_path:path}'
my_router.add_api_route(route_path, endpoint=foo)
app.include_router(my_router)

输入测试：

http://127.0.0.1:8000/foo/https://placebear.com/cache/395-205.jpg

输出：

{"rest_of_path":"https://placebear.com/cache/395-205.jpg"}

Answer 2

这将生成一个具有新签名的函数（我假设每个参数都是字符串）：

from fastapi import APIRouter
import re
import inspect

my_router = APIRouter()


def generate_function_signature(route_path: str):
    args = {arg: str for arg in re.findall(r'\{(.*?)\}', route_path)}
    
    def new_fn(**kwargs):
        return {"Result": kwargs['xyz']}

    params = [
        inspect.Parameter(
            param,
            inspect.Parameter.POSITIONAL_OR_KEYWORD,
            annotation=type_
        ) for param, type_ in args.items()
    ]

    new_fn.__signature__ = inspect.Signature(params)
    new_fn.__annotations__ = args
    return new_fn


read_from_file = '/foo/{xyz}' # Assume this is read from a file

my_router.add_api_route(
    read_from_file,
    endpoint=generate_function_signature(read_from_file)
)

但是，我相信有更好的方法来做您想做的任何事情，但我需要先了解您的问题