FastAPI Swagger文档如何实现嵌套接口展示?

DDD
发布: 2024-11-17 10:54:01
原创
357人浏览过

fastapi swagger文档如何实现嵌套接口展示?

fastapi swagger 文档的嵌套展示

想要在 swagger 文档中展示嵌套结构,例如后台管理下包含用户管理和文章管理,用户管理下包含 a 接口和 b 接口,文章管理下包含 c 接口和 d 接口。

当前效果:

  • 后台管理

    燕雀Logo
    燕雀Logo

    为用户提供LOGO免费设计在线生成服务

    燕雀Logo 101
    查看详情 燕雀Logo
    • a 接口
    • b 接口
    • c 接口
    • d 接口
  • 用户管理

    • a 接口
    • b 接口
  • 文章管理

    • c 接口
    • d 接口

期望效果:

  • 后台管理

    • 用户管理

      • a 接口
      • b 接口
    • 文章管理

      • c 接口
      • d 接口

代码:

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

# routerUser 包含 a, b 接口
routerAdmin.include_router(routerUser, prefix='/user')

# routerArticle 包含 c, d 接口
routerAdmin.include_router(routerArticle, prefix='/article')

app = FastAPI()

app.include_router(routerAdmin)
登录后复制

实现:

目前 openapi 规范不支持嵌套结构。因此,无法使用 fastapi 的内置 swagger ui 来实现上述嵌套展示效果。

然而,可以通过使用第三方插件来实现嵌套展示。例如,fastapi-swaggerui-template 插件可以提供自定义 swagger ui 模版,并支持嵌套结构的展示。

但是,需要注意的是,第三方插件的使用可能会引入额外的依赖关系和复杂性,需要谨慎选择。

以上就是FastAPI Swagger文档如何实现嵌套接口展示?的详细内容,更多请关注php中文网其它相关文章!

相关标签:
最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
热门推荐
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号