lf-open-java-swagger2word

swagger转word,pdf文档

License

License

Categories

Categories

Java Languages Swagger Program Interface REST Frameworks
GroupId

GroupId

com.github.a982338665
ArtifactId

ArtifactId

lf-open-java-swagger2word
Last Version

Last Version

1.0.2-RELEASE
Release Date

Release Date

Type

Type

jar
Description

Description

lf-open-java-swagger2word
swagger转word,pdf文档
Project URL

Project URL

https://github.com/a982338665/lf-open-java-swagger2word.git
Source Code Management

Source Code Management

https://github.com/a982338665/lf-open-java-swagger2word

Download lf-open-java-swagger2word

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.a982338665/lf-open-java-swagger2word/ -->
<dependency>
    <groupId>com.github.a982338665</groupId>
    <artifactId>lf-open-java-swagger2word</artifactId>
    <version>1.0.2-RELEASE</version>
</dependency>
// https://jarcasting.com/artifacts/com.github.a982338665/lf-open-java-swagger2word/
implementation 'com.github.a982338665:lf-open-java-swagger2word:1.0.2-RELEASE'
// https://jarcasting.com/artifacts/com.github.a982338665/lf-open-java-swagger2word/
implementation ("com.github.a982338665:lf-open-java-swagger2word:1.0.2-RELEASE")
'com.github.a982338665:lf-open-java-swagger2word:jar:1.0.2-RELEASE'
<dependency org="com.github.a982338665" name="lf-open-java-swagger2word" rev="1.0.2-RELEASE">
  <artifact name="lf-open-java-swagger2word" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.github.a982338665', module='lf-open-java-swagger2word', version='1.0.2-RELEASE')
)
libraryDependencies += "com.github.a982338665" % "lf-open-java-swagger2word" % "1.0.2-RELEASE"
[com.github.a982338665/lf-open-java-swagger2word "1.0.2-RELEASE"]

Dependencies

compile (6)

Group / Artifact Type Version
com.fasterxml.jackson.core : jackson-databind jar 2.9.6
org.apache.poi : poi jar 3.14
org.apache.poi : ooxml-schemas jar 1.3
org.apache.poi : poi-ooxml-schemas jar 3.14
org.apache.xmlbeans : xmlbeans jar 2.6.0
org.apache.poi : poi-examples jar 3.14

Project Modules

There are no modules declared in this project.

lf-open-java-swagger2word 简介

swagger2转word文档,pdf文档等
1.JSON解析部分部分借鉴 https://github.com/JMCuixy/swagger2word.git
2.pdf文档生成暂未开发
3.基础属性可配置

1.引入依赖

<dependency>
    <groupId>com.github.a982338665</groupId>
    <artifactId>lf-open-java-swagger2word</artifactId>
    <version>1.0.0-RELEASE</version>
</dependency>

2.使用的依赖包

2.1 pom.xml

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.6</version>
</dependency>
<!--docx处理:表格,图片等,可用于预设模板处理,如准考证打印-->
<!-- 也用于表格处理 xls/xlsx-->
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>3.14</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>ooxml-schemas</artifactId>
    <version>1.3</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml-schemas</artifactId>
    <version>3.14</version>
</dependency>
<dependency>
    <groupId>org.apache.xmlbeans</groupId>
    <artifactId>xmlbeans</artifactId>
    <version>2.6.0</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-examples</artifactId>
    <version>3.14</version>
</dependency>

2.2 非pom管理的jar包

主要用来将 word文档 转为 pdf文档 位置:/resources/lib

aspose-words-14.9.0-jdk16.jar

3 使用

3.1 简单使用

1.生成接口文档到指定位置:
    //设置即将生成的文档的基本属性
    SetDocxConf instance = SetDocxConf.getInstance();
    instance.setFilePath("xxx.docx");
    //swagger导出的json文件的文档
    String file = "./xxx.json";
    boolean b = GenerateDocxUtils.generateDocxByFile(file);
    System.err.println(b);
2.方法介绍:
    boolean generateFile(String file) :
        参数:file-读取的本地json文件路径
        返回:true or false
    boolean generateFileByJSON(String reader) :
        参数:reader-JSON文件的内容
        返回:true or false
    XWPFDocument generateXWPFDocumentByJSON(String reader):
        参数:reader-JSON文件的内容
        返回:XWPFDocument
    XWPFDocument generateXWPFDocument(String file):
        参数:file-读取的本地json文件路径
        返回:XWPFDocument

3.2 可选择设置属性介绍 SetDocxConf.class

默认的文件导出路径,项目根路径下 filePath = "InterfaceFile.docx"
首页介绍的 key (一级标题:固定名称)
    firstName = "系统简介";
    docxDesc = "【文档描述】:";
    docxVersion = "【文档版本】:";
    swaggVersion = "【Swagger版本】:";
    contactName = "【联系人】:";
    contactUrl = "【联系地址】:";
    contactEmail = "【联系邮件】:";
    docxTime = "【创建时间】:";
文档的创建时间可以自己定义,不定义的时候取当前时间为准
docxTimeValue = null;
避免标题重复的 标题分隔符
private String splitTitle = "@@@WE-";
接口文档前缀
    interDesc = "【协议描述】:";
    interUrl = "【接口地址】:";
    interMethod = "【请求方式】:";
    interType = "【请求类型】:";
    interTypeRes = "【响应类型】:";
    interReq = "【请求参数】:";
    interRes = "【响应参数】:";
    interExample = "【请求示例】:";
示例中表格的首列内容
    interReqExample = "请求参数";
    interResExample = "响应参数";
字体相关设置;
    行间距
    textPosition = 2;
    标题字体
    textTitleFont = "宋体";
    标题颜色
    textTitleColor = "000000";
    内容字体
    textContentFont = "宋体";
    文档主题目大小
    textMainTitleFontSize = 26;
    文档1级标题大小
    textFirstTitleFontSize = 22;
    文档2级标题大小
    textSecondTitleFontSize = 18;
    文档3级标题大小
    textThreeTitleFontSize = 14;
    文档4级标题大小
    textFourTitleFontSize = 10;
    文本大小
    textFontSize = 12;
颜色相关设置:
    请求参数列表行头颜色
    reqRowColor = "2EC6BD";
    请求参数列表行体颜色
    reqBodyColor = "CCCCCC";
    响应参数列表行头颜色
    resRowColor = "C2C3FD";
    响应参数列表行体颜色
    resBodyColor = "CCCCCC";
    请求示例 的第一列颜色
    resExampleFirstCellColor = "B4ACC6";
    请求示例 的其他列颜色
    resExampleOtherCellColor = "CCCCCC";

4.分支介绍:

pdf-aspose 分支是 包含有 aspose方式,将wprd文档完美转换为pdf的项目
由于该包是付费版,为去除水印,使用破解版jar包
使用方式 - 参见类:GenerateDocxUtils中的方法介绍

5.tag介绍:

V1.0.0: 仅支持Swagger转word文档,添加依赖直接使用
V2.0.0:添加支持Swagger转PDF文档,包含word文档转PDF,但是不能直接引用中央仓库依赖使用,需要下载该项目,mvn install使用
V3.0.0:持续...寻找其他方式进行pdf文档生成或转换

6.响应到浏览器

//1.设置文件ContentType类型,这样设置,会自动判断下载文件类型   
response.setContentType("multipart/form-data");   
//2.设置文件头:最后一个参数是设置下载文件名(假如我们叫a.pdf)   
response.setHeader("Content-Disposition", "attachment;fileName="+"a.pdf");   
//通过文件路径获得File对象(假如此路径中有一个download.pdf文件)   
        File file = new File(path + "download/" + "download.pdf");   
  
        try {   
            FileInputStream inputStream = new FileInputStream(file);   
  
            //3.通过response获取ServletOutputStream对象(out)   
            out = response.getOutputStream();   
  
            int b = 0;   
            byte[] buffer = new byte[512];   
            while (b != -1){   
                b = inputStream.read(buffer);   
                //4.写到输出流(out)中   
                out.write(buffer,0,b);   
            }   
            inputStream.close();   
            out.close();   
            out.flush();   
  
        } catch (IOException e) {   
            e.printStackTrace();   
        }  

7 升级问题

1.java.lang.NoClassDefFoundError: org/apache/poi/POIXMLTypeLoader
    查看是否有jar包冲突覆盖问题,类加载时会有先后顺序

Versions

Version
1.0.2-RELEASE
1.0.0-RELEASE