目前,大家通常都是用Swagger来编写Rest API文档,使用Swagger注解和Springfox,可以方便的从源代码生成文档,保持文档和源码一致。使用Swagger-ui工具,接口的消费方可以查看接口定义并从浏览器直接调用接口。如何实现Swagger和Spring Boot项目的结合,可以参考文章Spring Boot RESTful API Documentation With Swagger 2和Springfox的官方文档。
但是,有时我们为其它读者提供API文档,例如尊贵的客户领导要验收工作成果,Swagger UI就显得不太正式了,而且要连接上运行Swagger UI的服务器才可以完整的查看。最近,笔者找到了工具swagger2markup和asciidoctor,结合起来使用就可以输出优美的API文档了,供大家参考。
使用Swagger2Markup Demo
笔者尝试了多种方式后,发现结合swagger2markup和asciidoctor两个工具需要较多的配置,Swagger2Markup Demo项目已经做好了基本的配置,是一个Quick-Wins的路径。
样例程序的使用
从GitHub上克隆Swagger2Markup Demo项目,然后导入WorkSp