一 前言

好用的API管理工具能让我们快速的了解API接口，很多项目都是用swagger，但是swagger侵入代码太强了，现在介绍个轻量级的API管理工具apiDoc。

二 japiDoc地址

https://gitee.com/yeguozhong/JApiDocs

三 Japi使用

1、添加依赖

<dependency>
  <groupId>io.github.yedaxia</groupId>
  <artifactId>japidocs</artifactId>
  <version>1.4.3</version>
</dependency>

2、配置文件设置
随意新建一个mian方法，添加如下内容

public class Api {
    public static void main(String[] args) {
        DocsConfig config = new DocsConfig();
        config.setProjectPath("D:\\wangxinqiao\\xiaomiMall\\mall\\mall-eureka"); //项目的根目录地址
        config.setProjectName("ProjectName"); // project name
        config.setApiVersion("V1.0");       // api version
        config.setDocsPath("D:\\wangxinqiao\\xiaomiMall\\mall\\mall-eureka"); // API 文档生产地址根目录
        config.setAutoGenerate(Boolean.TRUE);  // auto generate
        Docs.buildHtmlDocs(config); // execute to generate
    }
}

3、写controller,api接口

/**
 * FileName: UserController
 * Author:   WXQ
 * Date:     2020/9/22 0022 9:50
 * Description:
 * History:
 */
@RequestMapping("/api/user/")
@RestController
public class UserController {


    /**
     * Get User List
     * @param listForm
     */
    @RequestMapping(path = "list", method = {RequestMethod.GET,  RequestMethod.POST}  )
    public String list(String listForm){
        return null;
    }
}

4、执行main方法，与项目是否启动无关
直接启动main方法，不用启动项目，启动成功后日志如下

图片.png

5、查看结果
会在配置的地址生成文件，如下

图片.png

双击index.html，打开后会出现api 文档

图片.png