springboot项目中利用poi将json导出成标准接口文档到word（swagger样式）

慕木兮人可

已于 2022-06-30 10:15:23 修改

阅读量1.6k

点赞数

分类专栏：企业项目BUG 文章标签： spring boot json java poi word

于 2022-06-29 16:06:38 首次发布

本文链接：https://blog.csdn.net/qq_38616503/article/details/125523007

版权

本文档介绍如何在springboot项目中，利用poi将json格式的API信息转换成标准的接口文档Word文件。文章详细阐述了从问题描述、痛点到解决办法的全过程，包括尝试FreeMarker模板、poi和easypoi等方法，最终选择了使用poi来手动创建Word文件。文章还提供了pom.xml配置、数据源json、ExportWordUtil工具类和文件导出controller的相关内容，并附带了参考链接。

摘要由CSDN通过智能技术生成

一、问题描述

根据业务需求需要，需要将json格式的api信息【比如postman导出接口文档这类的】，导出成标准接口文档的word文件。
该平台是将一些好的第三方平台接口接入进来，供用户使用，每个用户下有可以使用的接口，可以根据需要，将这些api勾选导出成标准接口文档的样式。

二、问题痛点

接到需求后呢，觉得应该不难啊，不就是导出吗，结果听完需求描述傻眼了，市面上并没有封装完全且符合需求的组件或者源码，就很头疼

三、解决办法

3.1利用FreeMarker模板

3.2利用poi

3.3利用easypoi(其实是对poi的封装，在某些方面的需求有着特殊的优势)

四、问题解决

最终采用poi，手搓导出word。[真的痛苦]

4.1pom.xml

		<dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi-scratchpad</artifactId>
            <version>3.17</version>
        </dependency>

        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi-ooxml</artifactId>
            <version>3.17</version>
        </dependency>

        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi</artifactId>
            <version>3.17</version>
        </dependency>
        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>ooxml-schemas</artifactId>
            <version>1.1</version>
        </dependency>

4.2数据源json

package com.juhe.oceanus.service.vo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.List;

/**
 * @author kiki
 * @date 2022/6/28
 * @description
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ApiExportDataVo {
   
    private Long id;

    private String title;

    private String name;

    private String description;

    private ApiParamVo apiParamVo;

    private List<RequestParamVo> requestParamVoList;

    private List<ResponseParamVo> responseParamVoList;

    private List<ErrorCodeVo> errorCodeVoList;

}

package com.juhe.oceanus.service.vo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author kiki
 * @date 2022/6/28
 * @description
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ApiParamVo {
   
    private String apiAddress;

    private String apiReturn;

    private String apiRequest;

}

package com.juhe.oceanus.service.vo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author kiki
 * @date 2022/6/28
 * @description
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class RequestParamVo {
   
    private Long id;

    private String paramName;//参数名称

    private String paramCode;//参数编码

    private String paramType;//参数类型

    private String paramMust;//是否必填

    private String paramSensitive;//是否脱敏

    private String paramDesc;//参数说明
}

package com.juhe.oceanus.service.vo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author kiki
 * @date 2022/6/28
 * @description
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ResponseParamVo {
   

    private Long id;

    private String paramName;//名称

    private String paramCode;//编码

    private String paramType;//类型

    private String paramDesc;//描述
}

package com.juhe.oceanus.service.vo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author kiki
 * @date 2022/6/28
 * @description
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ErrorCodeVo {
   

    private Long id;