fastapi自带swagger文档如何嵌套展示?

Dreamer

7110

发布于
2023-11-02 浙江

swagger展示目标效果

后台管理
- 用户管理
  - a接口
  - b接口
- 文章管理
  - c接口
  - d接口

现在效果

后台管理
- a接口
- b接口
- c接口
- d接口
用户管理
- a接口
- b接口
文章管理
- c接口
- d接口

代码

routerAdmin = APIRouter(
    prefix='/admin',
    tags=['后台管理']
)

# routerUser文件a,b路由
routerAdmin.include_router(routerUser)
# routerAdmin文件c,d路由
routerAdmin.include_router(routerArticle)

app = FastAPI()

app.include_router(routerAdmin)

问: 可以实现目标效果吗,如何实现.

python fastapi swagger

阅读 1.6k

AI BotBETA

可以，您可以通过自定义 Swagger/OpenAPI 文档的生成来实现目标效果。

FastAPI 使用 fastapi_openapi 包来生成 OpenAPI 文档，您可以通过自定义该包来达到目标效果。

首先，您需要安装 fastapi_openapi3 包，而不是默认的 fastapi_openapi。这可以通过以下命令完成：

pip install fastapi_openapi3

然后，您需要创建一个新的文件，例如 openapi.yaml，并定义您的 OpenAPI 文档。这将需要包括您想要显示的自定义标签和路由。然后，您可以创建一个 TagObject 对象，该对象将用于定义标签。在您的 TagObject 中，您可以添加一个 children 属性，该属性将包含您的子标签和路由。

例如：

from fastapi import FastAPI, Depends, HTTPException, status, Tag, Security, Form
from fastapi_openapi import FastAPIOpenAPI
from fastapi_openapi.auto_tag import AutoTag

app = FastAPI()

openapi = FastAPIOpenAPI(title="Your App", version="0.1.0", openapi_version="3.0.2")
openapi.add_tag(name="后台管理", description="后台管理相关接口", children=[
    AutoTag(name="用户管理", description="用户管理相关接口", children=[
        routerUser,  # 注意：这里应该是你的用户管理路由
    ]),
    AutoTag(name="文章管理", description="文章管理相关接口", children=[
        routerArticle,  # 注意：这里应该是你的文章管理路由
    ]),
])

最后，您需要在您的应用中包含 openapi：