如何为 FastAPI 中的每个端点生成独立的 Swagger UI 文档页面，而不是为一页中的所有端点生成 API 文档？

Question

有没有办法在其自己的页面上生成每个端点，而不是在单个页面上生成所有端点的文档，如下所示：

我想在其自己的专用页面上显示图书的 GET 端点，而不显示所有其他端点。我想要这个是因为我正在使用 iframe 标签来嵌入特定端点的 UI。

Answer 1

您可以使用子应用程序生成单独的 Swagger UI (OpenAPI) 自动文档。

在以下示例中，您可以在 http://127.0.0.1:8000/docs 访问 main API 的 Swagger UI 自动文档，以及在 http://127.0 访问 sub API 的文档.0.1:8000/subapi/docs.

示例

from fastapi import FastAPI

app = FastAPI()


@app.get("/app")
def read_main():
    return {"message": "Hello World from main app"}


subapi = FastAPI()


@subapi.get("/sub")
def read_sub():
    return {"message": "Hello World from sub API"}


app.mount("/subapi", subapi)

如果您想在单个

/docs

页面中对端点进行分组/排序，请查看此答案。