SpringBoot 自动生成API文档

最新推荐文章于 2024-08-29 07:00:00 发布

股海孙悟空

最新推荐文章于 2024-08-29 07:00:00 发布

阅读量678

点赞数

本文链接：https://blog.csdn.net/qq_32440951/article/details/84112676

版权

SpringBoot 自动生成API文档

在做项目的时候，如果项目是前后分离的，后端一定要和前端或者是移动端对接接口，那么问题来了，接口是不是要自己写给他们看，一般的会采用Excel或者Word来写，高级一点的就采用API管理平台手工录入，一个项目有上千上万个接口，天啊，这是多么大的工作量，在接口维护的时候更加痛苦，为了解决这样的事我们可以借助 japi 这个项目来完成RESTFul文档的自动生成，完全基于注释生成，更多详细配置可查看https://github.com/dounine/japi。

使用说明

克隆项目下来

git clone https://github.com/dounine/japi.git

编译打包

cd japi/java
gradle install -xtest

运行JAPI后台管理

cd japi/java
gradle bootRun

运行JAPI文档界面

cd japi/node
node app.js

生成RESTFul文档

maven项目

<dependency>
    <groupId>com.dounine.japi</groupId>
    <artifactId>client</artifactId>
    <version>1.0</version>
</dependency>

gradle项目

compile group: 'com.dounine.japi', name: 'client', version: '1.0'

编辑resources/japi.properties配置文件

japi.name=test
japi.uuid=43a600877430438596de3d330e4bd06e
japi.version=1.0.0
japi.author=lake
japi.url=http://192.168.0.123:8080
japi.description=this is project description.
japi.createTime=2017-02-23 10:44:44
japi.icon=/home/lake/github/japi/html/img/logo.png
japi.server=http://192.168.0.179:7778
japi.server.username=japi
japi.server.password=japi123

编写一个action

/**
 * 获取用户列表
 * @param user 用户信息
 * @return class User
 * @version v2
 */
@GetMapping(value = "v2/list")
public Result hots(@Validated({User.UserDEL.class}) User user) throws RuntimeException {
<span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span>;

}

编写一个API生成类
JapiCreateTest.java

@Test
    public void testCreate(){
        JapiClient.setPrefixPath("/home/lake/github/test-japi/java/");//项目路径前缀
        JapiClient.setpostfixPath("/src/main/java");//项目路径后缀
    JapiClient.setProjectJavaPath(<span class="hljs-string">"client"</span>);<span class="hljs-comment">//主项目地扯</span>
    JapiClient.setActionReletivePath(<span class="hljs-string">"com/dounine/test-japi/action"</span>);<span class="hljs-comment">//相对主项目action包所在路径</span>
    <span class="hljs-comment">//JapiClient.setIncludeProjectJavaPath(new String[]{"api"});//主项目中关联的其它项目包路径</span>
    JapiClient.setIncludePackages(<span class="hljs-keyword">new</span> String[]{<span class="hljs-string">"com.dounine.test-japi"</span>});<span class="hljs-comment">//关联的包,用于准确快速搜索</span>
    JapiClient.saveHistory(<span class="hljs-keyword">true</span>);<span class="hljs-comment">//是否保留本地历史版本</span>
    JapiClient.setFlushServer(<span class="hljs-keyword">false</span>);<span class="hljs-comment">//强制同步本地与服务器所有的版本（会先删除服务器以前的历史版本）</span>

    IProject project = ProjectImpl.init();
    JapiClientStorage japiClientStorage = JapiClientStorage.getInstance();
    japiClientStorage.setProject(project);
    japiClientStorage.autoSaveToDisk();<span class="hljs-comment">//自动使用到本地磁盘==&gt; 用户目录/.japi-client/</span>
    <span class="hljs-keyword">new</span> JapiClientTransfer().autoTransfer(japiClientStorage);<span class="hljs-comment">//文件传输到主服务器.</span>
}