SpringBoot是怎么自动生成API文档的

这篇文章主要讲解了“SpringBoot是怎么自动生成api文档的”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“springBoot是怎么自动生成API文档的”吧！

前言

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

使用说明

克隆项目下来

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

编译打包

cd japi/javagradle install -xtest

运行JAPI后台管理

cd japi/javagradle bootRun

运行JAPI文档界面

cd japi/nodenode 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=testjapi.uuid=43a600877430438596de3D330e4bd06ejapi.version=1.0.0japi.author=lakejapi.url=http://192.168.0.123:8080japi.description=this is project description.japi.createTime=2017-02-23 10:44:44japi.icon=/home/lake/github/japi/html/img/loGo.pngjapi.server=http://192.168.0.179:7778japi.server.username=japijapi.server.password=japi123

编写一个action

@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接口

使用场景

JAPI最适合在SpringCloud这样的分布式多模块项目中使用，内置强大的正则表达式，这会让代码注释更加规范，区别于swigger这类使用侵入式注解生成文档的,JAPI是完全基于标准注释生成的,支持强大的JSR303或者是自定义注解。

感谢各位的阅读，以上就是“SpringBoot是怎么自动生成API文档的”的内容了，经过本文的学习后，相信大家对SpringBoot是怎么自动生成API文档的这一问题有了更深刻的体会，具体使用情况还需要大家实践验证。这里是编程网，小编将为大家推送更多相关知识点的文章，欢迎关注！