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

作者站长头像
站长
· 阅读数 6

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)

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

回复
1个回答
avatar
test
2024-06-25

目前 OpenAPI 规范不支持嵌套。

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

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

参考自:stackoverflow

回复
likes
适合作为回答的
  • 经过验证的有效解决办法
  • 自己的经验指引,对解决问题有帮助
  • 遵循 Markdown 语法排版,代码语义正确
不该作为回答的
  • 询问内容细节或回复楼层
  • 与题目无关的内容
  • “赞”“顶”“同问”“看手册”“解决了没”等毫无意义的内容