摘要：首先是从下载了，这个已经能够生成和文档了，但是对中文支持不好，中文大部分会显示为空白。关于这个对中文支持不好，查了很多资料，应该是字体和主题的原因，所以参考了很多资料，结合当前这个，做出了最终的能很好支持中文的，最终地址。
做后端开发，自然离不开接口文档，接口文档不仅方便后端开发人员之间查看，更是前端人员必要的文档，也有可能提供给第三方来调用我们的接口。但是，写接口文档太费时间，而且如果没有确定好格式，每个人写的接口文档可能各不相同，看起来就会很混乱。
好在swagger出现了，如果你的spring boot项目集成了swagger，而且接口和入参出参实体类加上了swagger相关的注解(参考最终demo中的controller和model)，那么，就可以通过http://ip:port/swagger-ui.html(ip和port换成自己配置的)来访问在线的接口，在此页面也可以直接测试接口。对spring boot和swagger不了解的建议先学习一下，近年来很火，使用起来也确实方便。但是我们肯定不会满足在线访问就可以了的，有时候会需要离线的接口文档，于是就有了swagger2markup、springFox、asciidoctor几个插件来帮助我们生成离线的HTML和PDF格式的文档。
关于使用swagger生成HTML或者PDF的原理，可以参考这篇文章：使用 SpringFox、Swagger2Markup、Spring-Restdoc和 Maven 构建 RESTful API文档。
首先是从spring-swagger2markup-demo下载了demo，这个demo已经能够生成HTML和PDF文档了，但是对中文支持不好，中文大部分会显示为空白。如果你的接口文档是全英文的，那么就用这个就可以了。关于这个demo对中文支持不好，查了很多资料，应该是字体和主题的原因，所以参考了很多资料，结合当前这个demo，做出了最终的能很好支持中文的demo，最终demo地址：swagger2pdf。
生成的文档存放的目录：当前项目的targetasciidochtml和targetasciidocpdf分别存放着HTML文档和PDF文档。
关于接口和入参出参实体类中用到的swagger注解，可以参考这篇博客：swagger2常用注解说明。
最终生成的HTML文档和PDF文档效果图：
由于参考了很多资料都没有成功，只记录了最后成功的链接，没有记录下其他的链接，如果您觉得其中有参考您的部分，可以留言留下您的地址，我会加到参考的链接里的。
主要参考：
https://github.com/Swagger2Ma...
https://blog.csdn.net/lihuaij...
https://github.com/woshihouji...
文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。
转载请注明本文地址：https://www.ucloud.cn/yun/73713.html
摘要：没错，不支持，从导出的文档也可以看到，部分中文无法显示，目前我也尚未找到是否有配置可以实现这个功能。相对前面的方式，使用起来更加简单，也可以修改配置输出中文。 更多精彩博文，欢迎访问我的个人博客 说明 我个人是一直使用Swagger作为接口文档的说明的。但是由于在一些情况下，接口文档说明需要以文件的形式交付出去，如果再重新写一份文档难免有些麻烦。于是在网上看到了Swagger2Mar...
摘要：其标准为前身是，提供强大的在线编辑功能，包括语法高亮错误提示自动完成实时预览，并且支持用户以格式撰写导入导出转换文档。 团队内部RestAPI开发采用设计驱动开发的模式，即使用API设计文档解耦前端和后端的开发过程，双方只在联调与测试时耦合。在实际开发和与前端合作的过程中，受限于众多因素的影响，开发效率还有进一步提高的空间。本文的目的是优化工具链支持，减少一部分重复和枯燥的劳动。 现状...
摘要：使用生成，我们可以得到交互式文档，自动生成代码的以及的发现特性等。方法指定扫描的包会生成文档默认是显示所有接口可以用注解标识该接口不显示。 程序员都很希望别人能写技术文档，自己却很不愿意写文档。因为接口数量繁多,并且充满业务细节,写文档需要花大量的时间去处理格式排版,代码修改后还需要同步修改文档,经常因为项目时间紧等原因导致文档滞后于代码，接口调用方的抱怨声不绝于耳。而程序员是最擅长偷...
摘要：前后端分离后，维护接口文档基本上是必不可少的工作。一个理想的状态是设计好后，接口文档发给前端和后端，大伙按照既定的规则各自开发，开发好了对接上了就可以上线了。本文主要和大伙来聊下在中如何整合。如此，就算配置成功了，非常方便。 前后端分离后，维护接口文档基本上是必不可少的工作。一个理想的状态是设计好后，接口文档发给前端和后端，大伙按照既定的规则各自开发，开发好了对接上了就可以上线了。当然...
摘要：集成生成接口文档原文简介由于的特性，用来开发变得非常容易，并且结合来自动生成文档变得方便快捷。使用生成，我们可以得到交互式文档。听过与的结合，生成更加完备的文档。接下来将基于与搭建完整的文档系统。 Spring Boot Swagger2 集成REST ful API 生成接口文档 原文 简介 由于Spring Boot 的特性，用来开发 REST ful 变得非常容易，并且结合 Sw...
阅读 646·2021-10-09 09:41
阅读 623·2019-08-30 15:53
阅读 1053·2019-08-30 15:53
阅读 1189·2019-08-30 11:01
阅读 1542·2019-08-29 17:31
阅读 965·2019-08-29 14:05
阅读 1690·2019-08-29 12:49
阅读 387·2019-08-28 18:17
