FastAPI Swagger文档：如何优雅地展示嵌套路由？

fastapi自带swagger文档如何呈现嵌套层级？

在swagger文档中嵌套展示子路径是当下热门的需求，可以将不同功能模块的路由分组展示，提升文档的可读性和可维护性。

不幸的是，目前的openapi规范不支持嵌套结构。2017年提出的实现嵌套路由的issue至今尚未得到解决。

不过，有一个名为oas-nested-router的插件可以实现类似的效果，其在swagger ui中展示路径时，会以标题1|标题2|标题3的格式显示层级结构。

代码实现示例：

# 导入oas-nested-router
from oas_nested_router import NestedRouter

# 初始化嵌套路由
router = NestedRouter()

# 添加子路由
router.add_router(Router('/admin', tags=['后台管理']), tags=['后台管理'])
router.add_router(Router('/user', tags=['用户管理']), tags=['用户管理', '后台管理'])
router.add_router(Router('/article', tags=['文章管理']), tags=['文章管理', '后台管理'])

# 在FastAPI应用中包含嵌套路由
app = FastAPI()
app.include_router(router.get_router())

如此一来，swagger ui上的文档将以期望的嵌套结构显示：

• 后台管理

  • 用户管理

    • /user/a
    • /user/b

  • 文章管理

    • /article/c
    • /article/d