smart-doc无入侵接口文档生成

maven方式
第一步:引入插件

<build>
    <plugins>
      <!-- smart doc -->
      <plugin>
        <groupId>com.github.shalousun</groupId>
        <artifactId>smart-doc-maven-plugin</artifactId>
        <version>2.2.7</version>
        <configuration>
          <!--指定生成文档的使用的配置文件,配置文件放在自己的项目中-->
          <configFile>./src/main/resources/smart-doc.json</configFile>
          <!--指定项目名称-->
          <projectName>测试</projectName>
          <!--smart-doc实现自动分析依赖树加载第三方依赖的源码,如果一些框架依赖库加载不到导致报错,这时请使用excludes排除掉-->
          <excludes>
            <!--格式为:groupId:artifactId;参考如下-->
            <exclude>com.alibaba:fastjson</exclude>
          </excludes>
          <!--自1.0.8版本开始,插件提供includes支持,配置了includes后插件会按照用户配置加载而不是自动加载,因此使用时需要注意-->
          <!--smart-doc能自动分析依赖树加载所有依赖源码,原则上会影响文档构建效率,因此你可以使用includes来让插件加载你配置的组件-->
          <includes>
            <!--格式为:groupId:artifactId;参考如下-->
            <include>com.alibaba:fastjson</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>

    </plugins>
  </build>

第二步:添加smart-doc.json

{
  "outPath": "C:\\api",
  "serverUrl": "http://127.0.0.1:10908"
}
第三步:通过maven插件操作即可
选择导出:html或者postman为json形式
![导出操作示例](https://img-blog.csdnimg.cn/f007270409db4d47b11b83392829bd8e.jpeg)
其中HTML效果
![html最后效果](https://img-blog.csdnimg.cn/8eaeb687d3204475b17448a0abc032b3.jpeg)









版权声明:本文为weixin_42034919原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。