利用Swagger自动生成漂亮的静态开发文档说明页

效果

利用Swagger自动生成漂亮的静态文档说明页

地址：https://t.itmuch.com/doc.html

 

总体步骤

•整合Swagger，生成Swagger描述端点 /v2/api-docs

•使用 swagger2markup-maven-plugin ，将 /v2/api-docs 生成ASCIIDOC文件；

•使用 asciidoctor-maven-plugin ，将ASCIIDOC文件转换成HTML；

•部署

整合Swagger

TIPS

Swagger的使用非常简单，本文不展开探讨了，各位看官自行百度一下用法吧。

常用注解：

•@Api

•@ApiOperation

•@ApiModel

•@ApiModelProperty

1 加依赖

<!-- swagger -->
<!-- 之所以要排除，是因为如果不排除会报NumberFormatException的警告。 -->
&l