23｜管理接口：如何集成swagger自动生成文件？
叶剑峰
该思维导图由 AI 生成，仅供参考
你好，我是轩脉刃。
不管你是前端页面开发，还是后端服务开发，你一定经历过前后端联调的场景，前后端联调最痛苦的事情，莫过于没有完善的接口文档、没有可以调用调试的接口返回值了，所以一般都会采用形如 Postman 这样的第三方工具，来进行接口的调用和联调。
但是这一节课，我们要做的事情，就是为自己的 Web 应用集成 swagger，使用 swagger 自动生成一个可以查看接口、可以调用执行的页面。
swagger
说到 swagger，可能有的同学还比较陌生，我来简要介绍一下。swagger 框架在 2009 年启动，之前是 Reverb 公司内部开发的一个项目，他们的工程师在与第三方调试 REST 接口的过程中，为了解决大量的接口与文档问题，就设计了 swagger 这个项目。
项目最终成型的方案是，先设计一个 JSON 规则，开发工程师把所有服务接口按照这种规则来写成一个 JSON 文件，这个 JSON 文件可以直接生成一个交互式 UI，可以提供调用者查看、调用调试。
swagger 的应用是非常广泛的。非常多的开源项目在提供对外接口的时候都使用 swagger 来进行描述。比如目前最火的 Kubernetes 项目，每次在发布版本的时候，都会在项目根目录上，带上符合 swagger 规则的JSON 文件，用来向使用者提供内部接口。
公开
同步至部落
取消
完成
0/2000
荧光笔
直线
曲线笔记
复制
AI
- 深入了解
- 翻译
- 解释
- 总结
本文介绍了如何将swagger集成到hade框架中，以及如何使用swagger进行自动生成文件和前端调试工具。通过引入swag项目和gin-swagger中间件，成功将swagger融入hade框架，并实现了通过配置同时启动hade后端服务和swagger前端调试工具的功能。文章详细介绍了集成过程，包括命令设计、路由存放、配置项设置等步骤，并提供了验证和小结。通过本文，读者可以快速了解swagger的基本概念、使用方法和注释规范，以及如何将swagger集成到hade框架中。同时，文章还提出了思考题，鼓励读者分享自己在实际工作中使用swagger的经历。整体内容丰富，适合开发人员快速了解swagger集成和应用的技术特点。
仅可试看部分内容，如需阅读全部内容，请付费购买文章所属专栏
《手把手带你写一个 Web 框架》，新⼈⾸单¥59
《手把手带你写一个 Web 框架》，新⼈⾸单¥59
立即购买
© 版权归极客邦科技所有，未经许可不得传播售卖。 页面已增加防盗追踪，如有侵权极客邦将依法追究其法律责任。
登录 后留言
全部留言(3)
- 最新
- 精选
- Geek_62f18d您好，请问swagger的注释中的description.markdown怎么使用
作者回复: https://github.com/gohade/coredemo/commit/26ad0cd830ad0da062a2a24cc517458e2dad704f 我写了一个例子在geekbang/24分支上，你可以参考看下。
2021-12-011 
taoistswag v1.7.9及后续版本gen.Config,需要添加 OutputTypes: []string{"yaml", "json", "go"} , 指定生成文件的类型。2024-01-24归属地：山东
大神博士go swagger 可以换主题吗，默认主题太难用了。2023-08-14归属地：上海
收起评论
