内容简介：先介绍网上“搜刮”的资源：怎么把这些 API 信息漂亮地展示出来呢？ 接下来我们通过集成 Swagger UI 来实现。首先是下载 Swargger UI，它是一个 react 写成的纯前端项目，可以集成到任意服务端中，只要让可以读取到 API 的定义文件即可，所以呢，哪怕是 file:// 打开也行，它会解析可以访问到的 yaml/json 文件，渲染漂亮的文档出来。Swagger UI 不过就是 HTML+JS+CSS，到
先介绍网上“搜刮”的资源：
- Swagger从入门到精通，如何编写基于 OpenAPI 规范的 API 文档， https://legacy.gitbook.com/book/huangwenchao/swagger/details https://blog.csdn.net/lucky373125/article/details/80471525
- Swagger和OpenAPI https://www.breakyizhan.com/swagger/2806.html
- Swagger 2与OpenAPI 3 https://www.jianshu.com/p/879baf1cff07
和Swagger UI的集成
怎么把这些 API 信息漂亮地展示出来呢？ 接下来我们通过集成 Swagger UI 来实现。首先是下载 Swargger UI，它是一个 react 写成的纯前端项目，可以集成到任意服务端中，只要让可以读取到 API 的定义文件即可，所以呢，哪怕是 file:// 打开也行，它会解析可以访问到的 yaml/json 文件，渲染漂亮的文档出来。
Swagger UI 不过就是 HTML+JS+CSS，到 https://github.com/swagger-api/swagger-ui/tree/master/dist 下载，注意是 dist 发布版本。如果你前端动手能力强，可以使用非 dist 版的，通过 webpack 等其他方案集成。但那样就不是和 Java Web 项目集成了，另外一个 web service 服务在跑。我为了省事，集成在当前 java 项目中，用 tomcat 跑。
但也要注意一下访问权限的问题，不能让所有人都访问，特别是包含敏感信息的接口。
下载回来，解压，发现源码包含 map 用于调试的，好几兆呢，我们不要，只要 HTML/JS/CSS 便可。
运行一下，没毛病呢。
默认是 PetStore 的，打开 index.html 修改之。
修改为本地的即可。
最后，是不是觉得很简单呢？
还有很多好玩的，例如转换为 markdown，就要看看 swagger2markup https://blog.csdn.net/qq_34368762/article/details/79129303
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持 码农网
猜你喜欢:
- 在 Laravel 中集成 API 文档生成器扩展包为 Dingo API 接口生成文档
- 使用Sphinx生成/管理文档
- Java 生成 PDF 文档
- 文档生成器 mkdocs
- Doxygen 3 发布，文档生成工具
- 如何使用 sphinx 来生成代码文档
本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。
程序是怎样跑起来的
[日] 矢泽久雄 / 李逢俊 / 人民邮电出版社 / 2015-4 / 39.00元
本书从计算机的内部结构开始讲起，以图配文的形式详细讲解了二进制、内存、数据压缩、源文件和可执行文件、操作系统和应用程序的关系、汇编语言、硬件控制方法等内容，目的是让读者了解从用户双击程序图标到程序开始运行之间到底发生了什么。同时专设了“如果是你，你会怎样介绍？”专栏，以小学生、老奶奶为对象讲解程序的运行原理，颇为有趣。本书图文并茂，通俗易懂，非常适合计算机爱好者及相关从业人员阅读。一起来看看 《程序是怎样跑起来的》 这本书的介绍吧!
