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

  • Z时代
  • 2024-02-09
  • 分类：IT

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

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)

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

回答：

目前 OpenAPI 规范不支持嵌套。

2017 年有这个 issue 请求。据开发人员说会实现这个功能，但是目前已经 2023 年了，依然没动静。

貌似有个 插件 能实现：标题1|标题2|标题3。

参考自：stackoverflow。

回答：

FastAPI 集成的swagger不支持嵌套。
不过你可以通过其他工具来实现，之前我用过redoc（https://github.com/Redocly/redoc）来生成API 的文档
可以支持切换swagger，可导出OpenAPI标准格式的文档

以上是 fastapi自带swagger文档如何嵌套展示? 的全部内容， 来源链接： utcz.com/p/939052.html

回到顶部