SpringBoot 自动生成API文档

使用说明

git clone https://github.com/dounine/japi.git[/code] 
编译打包

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 {

return null;
}


编写一个API生成类

JapiCreateTest.java

@Test
public void testCreate(){
JapiClient.setPrefixPath("/home/lake/github/test-japi/java/");//项目路径前缀
JapiClient.setpostfixPath("/src/main/java");//项目路径后缀

JapiClient.setProjectJavaPath("client");//主项目地扯
JapiClient.setActionReletivePath("com/dounine/test-japi/action");//相对主项目action包所在路径
//JapiClient.setIncludeProjectJavaPath(new String[]{"api"});//主项目中关联的其它项目包路径
JapiClient.setIncludePackages(new String[]{"com.dounine.test-japi"});//关联的包,用于准确快速搜索
JapiClient.saveHistory(true);//是否保留本地历史版本
JapiClient.setFlushServer(false);//强制同步本地与服务器所有的版本（会先删除服务器以前的历史版本）

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


最后访问浏览器 http://localhost:7777
就可看到RESTFul文档登录


使用自己的帐号登录就可以看到所有项目


进入项目看详细RESTFul接口