SpringBoot 集成接口文档，老鸟们也被打脸了！

• …

接下来我们来看看SpringBoot中如何集成smart-doc。

SpringBoot集成 smart-doc

---

smart-doc支持多种方式生成接口文档：maven插件、gradle插件、单元测试（不推荐），这里我才用的是基于maven插件生成，步骤如下：

1. 引入依赖，版本选择最新版本

com.github.shalousun

smart-doc-maven-plugin

2.2.7

./src/main/resources/smart-doc.json

Smart-Doc初体验

重点在 configFile中指定smart-doc配置文件 smart-doc.json

2. 新建配置文件smart-doc.json

{

“outPath”: “src/main/resources/static/doc”

}

指定smart-doc生成的文档路径，其他配置项可以参考官方wiki。

3. 通过执行maven 命令生成对应的接口文档

//生成html

mvn -Dfile.encoding=UTF-8 smart-doc:html

当然也可以通过idea中的maven插件生成

4. 访问接口文档

生成接口文档后我们通过 http://localhost:8080/doc/api.html查看，效果如下：

看到这里的同学可能会呵呵一笑，就这？啥也没有呀！这还想让我替换Swagger？