![](/images/alipay.png)
接口文档生成工具类
smart-doc-maven-plugin
码云地址:https://gitee.com/TongchengOpenSource/smart-doc
官方文档:https://smart-doc-group.github.io/#/zh-cn/
这款是基于maven插件的形式,完全根据注释来生成文档的,无侵入。可以生成任意格式的文档,比如doc,html,markdown,postman ...等等。非常的强大 使用也是非常的简单。
1、添加插件
shell
<plugin>
<groupId>com.github.shalousun</groupId>
<artifactId>smart-doc-maven-plugin</artifactId>
<version>2.6.3</version>
<configuration>
<!--指定生成文档的使用的配置文件,配置文件放在自己的项目中-->
<configFile>./src/main/resources/smart-doc.json</configFile>
<!--指定项目名称,推荐使用动态参数,例如${project.description}-->
<!--如果smart-doc.json中和此处都未设置projectName,2.3.4开始,插件自动采用pom中的projectName作为设置-->
<projectName>${project.description}</projectName>
<!--smart-doc实现自动分析依赖树加载第三方依赖的源码,如果一些框架依赖库加载不到导致报错,这时请使用excludes排除掉-->
<excludes>
<!--格式为:groupId:artifactId;参考如下-->
<!--也可以支持正则式如:com.alibaba:.* -->
<exclude>com.alibaba:fastjson</exclude>
</excludes>
<!--includes配置用于配置加载外部依赖源码,配置后插件会按照配置项加载外部源代码而不是自动加载所有,因此使用时需要注意-->
<!--smart-doc能自动分析依赖树加载所有依赖源码,原则上会影响文档构建效率,因此你可以使用includes来让插件加载你配置的组件-->
<includes>
<!-- 使用了mybatis-plus的Page分页需要include所使用的源码包 -->
<include>com.baomidou:mybatis-plus-extension</include>
<!-- 使用了mybatis-plus的IPage分页需要include mybatis-plus-core-->
<include>com.baomidou:mybatis-plus-core</include>
<!-- 如果配置了includes的情况下, 使用了jpa的分页需要include所使用的源码包 -->
<include>org.springframework.data:spring-data-commons</include>
</includes>
</configuration>
<executions>
<execution>
<!--如果不需要在执行编译时启动smart-doc,则将phase注释掉-->
<phase>compile</phase>
<goals>
<!--smart-doc提供了html、openapi、markdown等goal,可按需配置-->
<goal>html</goal>
</goals>
</execution>
</executions>
</plugin>
2、创建配置文件 src\main\resources\smart-doc.json 是占位符。到时候在postman中可以替换变量。 ./doc 这个是指定生成的文档位置,这样写的话,会在项目的根目录生成一个doc的文件夹
json
{
"outPath": "./doc",
"serverUrl": "http://{{server}}",
"coverOld": true
}
这时候会出现maven的插件。右键运行即可。
apifox在线文档
优点是在线,简单,可调试,免费
1、idea下载插件Apifox Helper
2、登录 apifox官网,获取token
3、idea配置token
4、idea上传项目接口
5、预览