SpringBoot（十一）JApiDocs构建接口文档

Love The Way You Lie 2024-03-22 10:22 25阅读 0赞

## JApiDocs构建接口文档 ##

1.在前端和后端没分开之前，前端管理静态界面，html等静态资源，相关操作都是有后端通过模板引擎进行渲染。方便操作。 2.**前后端分离后，前端和后端人员无法做到及时沟通，解决问题的情况。所以必须通过生成接口文档来打交道**，但对于后端程序员又不想写接口文档，所以便有了接口文档生成工具，主要介绍两种文档生成工具Swagger、JApiDocs。

**JApiDocs 是一个符合 Java 编程习惯的 Api 文档生成工具**。最大程度地利用 Java 的语法特性，**你只管用心设计好接口，添加必要的注释，JApiDocs 会帮你导出一份漂亮的 Html 文档**，并生成相关的 Java 和 Object-C 相关数据模型代码，从此，Android 和 IOS 的同学可以少敲很多代码了，你也不需要费力维护接口文档的变化，只需要维护好你的代码就可以了。

### 1、添加依赖 ###

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

### 2、在任意一个main入口中执行以下方法 ###

创建在哪个项目的目录下就会生成该项目的接口文档

public static void main(String[] args) {
        //在测试类中运行main方法,生成html离线文档,在本地运行项目时可以直接当方法写在springboot的启动类中
        //生成japidocs构建接口文档
        DocsConfig config = new DocsConfig();
        // root project path   setProjectPath是项目根目录，
        config.setProjectPath("D:\\Java\\springboot练习\\pro-springboot\\boot05-springBootDemo"); 
        config.setProjectName("项目名称"); // project name
        config.setApiVersion("V1.0");       // api version
        // api docs target path  setDocsPath是文档的生成目录
        config.setDocsPath("D:\\Java\\springboot练习\\pro-springboot\\boot05-springBootDemo\\apidoc"); 
        config.setAutoGenerate(Boolean.TRUE);  // auto generate
        Docs.buildHtmlDocs(config); // execute to generate
    
    }

**在文件夹打开项目的文件夹，你就会发现多了一个文件夹，这就是生成的文档**

![875b63e339bd49729dfbb68c3892df83.png][]

![2c6b9d8d45834524bb382553c3356bff.png][]

**通过方法注释生成了接口文档，前端人员可以看到后端的参数和返回值**

![be61d6c4455a4a098dca8fb718805dbb.png][]

![e64d6320e8c64ccca42491c14d459d0f.png][]

[875b63e339bd49729dfbb68c3892df83.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/59e96414ea6c4491bceb5f34a609e5e0.png
[2c6b9d8d45834524bb382553c3356bff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/b7a96dab300e41ca9078e49f2d5029ac.png
[be61d6c4455a4a098dca8fb718805dbb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/45c5398c5dbe4c51b8089009eea504dd.png
[e64d6320e8c64ccca42491c14d459d0f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/2364b1db5bee42da86748c70f9059fe5.png