无入侵接口文档smart-doc

Smart-doc优点:

1.非侵入式生成接口文档
2.减少接口文档的手动更新麻烦&保证了接口文档和代码的一致
3.随时可生成最新的接口文档
4.保持团队代码风格一致:smart-doc支持javadoc,必须按照这个才能生成有注释的接口文档

最终效果

无入侵接口文档smart-doc_第1张图片

1.导入依赖

               <plugin>
                <groupId>com.github.shalousungroupId>
                <artifactId>smart-doc-maven-pluginartifactId>
                <version>2.2.7version>
                <configuration>
                    <configFile>./src/main/resources/smart-doc.jsonconfigFile>
                    <projectName>Smart-Doc初体验projectName>
                configuration>
            plugin>

2.在resources下新建smart-doc.json

无入侵接口文档smart-doc_第2张图片

{
  "serverUrl": "http://127.0.0.1:8081",
  "packageFilters": "com.demo.controller.DemoController",
  "isStrict": false,
  "allInOne": true,
  "outPath": "src/main/resources/static/doc",
  "projectName": "smart-doc"
}

3.复制到smart-doc.json

无入侵接口文档smart-doc_第3张图片

4.直接打开index.html

http://localhost:63342/demo/static/doc/index.html?_ijt=9d6ajticc8vm2ckffmddok81hj
无入侵接口文档smart-doc_第4张图片

你可能感兴趣的:(java)