com.github.lfopenjavaswagger2word.util

类 GenerateDocxUtils

java.lang.Object

com.github.lfopenjavaswagger2word.util.GenerateDocxUtils

public class GenerateDocxUtils
extends java.lang.Object

作者:

: Mr huangye URL : CSDN 皇夜_ createTime : 2020/7/16 17:04 Description :

构造器概要

构造器

构造器和说明
GenerateDocxUtils()

方法概要

限定符和类型	方法和说明
private static void	addReqParam(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> reqList, java.lang.String firstSuffix, java.lang.Object in, java.util.List<ModelAttr> properties)
private static void	addResParam(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> resList, java.lang.String firstSuffix, java.util.List<ModelAttr> properties)
private static void	generateDocContent(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> mappAll, java.util.Map<java.lang.String,java.lang.Object> map, java.lang.String host)
static boolean	generateFile(java.lang.String file, java.io.OutputStream outputStream) 通过读取本地JSON 生成本地接口文档 outputStream == null的时候默认在根目录下生成docx文件
static boolean	generateFileByJSON(java.lang.String reader, java.io.OutputStream outputStream) 生成本地接口文档 outputStream == null的时候默认在根目录下生成docx文件
static boolean	generateFileByJSONPDF(java.lang.String reader, java.io.OutputStream outputStream, java.lang.String watermarkText) 生成本地接口文档 outputStream == null的时候默认在根目录下生成pdf文件
static boolean	generateFilePDF(java.lang.String file, java.io.OutputStream outputStream, java.lang.String watermarkText) 通过读取本地JSON 生成本地接口文档pdf outputStream == null的时候默认在根目录下生成pdf文件
static void	generateXWPFDocument(java.lang.String file, java.io.OutputStream out) 通过读取本地JSON 返回文档对象 XWPFDocument doc 可通过以下方式写出文档：或者通过response返回前端 FioutputStream == null的时候默认在根目录下生成docx文件
static void	generateXWPFDocumentByJSON(java.lang.String reader, java.io.OutputStream out) 返回文档对象 XWPFDocument doc outputStream == null的时候默认在根目录下生成docx文件
static void	generateXWPFDocumentByJSONPDF(java.lang.String reader, java.io.OutputStream out, java.lang.String watermarkText) 返回文档对象 XWPFDocument doc outputStream == null的时候默认在根目录下生成pdf文件
static void	generateXWPFDocumentPDF(java.lang.String file, java.io.OutputStream out, java.lang.String watermarkText) 通过读取本地JSON 返回文档对象 XWPFDocument pdf 可通过以下方式写出文档：或者通过response返回前端 FioutputStream == null的时候默认在根目录下生成pdf文件
private static ModelAttr	getAndPutModelAttr(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> swaggerMap, java.util.Map<java.lang.String,ModelAttr> resMap, java.lang.String modeName) 递归生成ModelAttr 对$ref类型设置具体属性
static java.lang.String	getHeaderByMap(java.util.Map<java.lang.String,java.lang.Object> map) 将map转换成header
static java.lang.String	getUrlParamsByMap(java.util.Map<java.lang.String,java.lang.Object> map) 将map转换成url
private static java.lang.Object	getValue(java.lang.String type, ModelAttr modelAttr) 例子中，字段的默认值
private static java.util.Map<java.lang.String,ModelAttr>	parseDefinitions(java.util.Map<java.lang.String,java.lang.Object> map) 解析Definition
private static java.util.Map<java.lang.String,java.lang.String>	parseWordIndex(java.util.Map<java.lang.String,java.lang.Object> map)
private static java.lang.String	processRequestParam(java.util.List<Request> list) 封装请求体
private static java.util.List<Response>	processResponseCodeList(java.util.Map<java.lang.String,java.lang.Object> responses) 处理返回码列表
private static ModelAttr	processResponseModelAttrs(java.util.Map<java.lang.String,java.lang.Object> responseObj, java.util.Map<java.lang.String,ModelAttr> definitinMap) 处理返回属性列表
private static java.lang.String	processResponseParam(java.util.Map<java.lang.String,java.lang.Object> responseObj, java.util.Map<java.lang.String,ModelAttr> definitinMap) 处理返回值

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

GenerateDocxUtils

public GenerateDocxUtils()

方法详细资料

generateFilePDF

public static boolean generateFilePDF(java.lang.String file,
                                      java.io.OutputStream outputStream,
                                      java.lang.String watermarkText)

通过读取本地JSON 生成本地接口文档pdf outputStream == null的时候默认在根目录下生成pdf文件

参数:

file - json文件

outputStream -

watermarkText - 水印内容，为null时不设置

抛出:

java.io.IOException

generateFileByJSONPDF

public static boolean generateFileByJSONPDF(java.lang.String reader,
                                            java.io.OutputStream outputStream,
                                            java.lang.String watermarkText)

生成本地接口文档 outputStream == null的时候默认在根目录下生成pdf文件

参数:

reader - swagger导出的json文件内容

outputStream -

watermarkText - 水印内容，为null时不设置

抛出:

java.io.IOException

generateXWPFDocumentByJSONPDF

public static void generateXWPFDocumentByJSONPDF(java.lang.String reader,
                                                 java.io.OutputStream out,
                                                 java.lang.String watermarkText)

返回文档对象 XWPFDocument doc outputStream == null的时候默认在根目录下生成pdf文件

参数:

reader - swagger导出的json文件内容

out - 输出流

watermarkText - 水印内容，为null时不设置

抛出:

java.io.IOException

generateXWPFDocumentPDF

public static void generateXWPFDocumentPDF(java.lang.String file,
                                           java.io.OutputStream out,
                                           java.lang.String watermarkText)

通过读取本地JSON 返回文档对象 XWPFDocument pdf 可通过以下方式写出文档：或者通过response返回前端 FioutputStream == null的时候默认在根目录下生成pdf文件

参数:

file -

out -

watermarkText - 水印内容，为null时不设置

抛出:

java.io.IOException

generateFile

public static boolean generateFile(java.lang.String file,
                                   java.io.OutputStream outputStream)

通过读取本地JSON 生成本地接口文档 outputStream == null的时候默认在根目录下生成docx文件

参数:

file -

outputStream -

抛出:

java.io.IOException

generateFileByJSON

public static boolean generateFileByJSON(java.lang.String reader,
                                         java.io.OutputStream outputStream)

生成本地接口文档 outputStream == null的时候默认在根目录下生成docx文件

参数:

reader - swagger导出的json文件内容

抛出:

java.io.IOException

generateXWPFDocumentByJSON

public static void generateXWPFDocumentByJSON(java.lang.String reader,
                                              java.io.OutputStream out)

返回文档对象 XWPFDocument doc outputStream == null的时候默认在根目录下生成docx文件

参数:

reader - swagger导出的json文件内容

out - 输出流

抛出:

java.io.IOException

generateXWPFDocument

public static void generateXWPFDocument(java.lang.String file,
                                        java.io.OutputStream out)

通过读取本地JSON 返回文档对象 XWPFDocument doc 可通过以下方式写出文档：或者通过response返回前端 FioutputStream == null的时候默认在根目录下生成docx文件

参数:

file -

out -

抛出:

java.io.IOException

generateDocContent

private static void generateDocContent(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,java.lang.Object>>> mappAll,
                                       java.util.Map<java.lang.String,java.lang.Object> map,
                                       java.lang.String host)
                                throws java.io.IOException

抛出:

java.io.IOException

processResponseParam

private static java.lang.String processResponseParam(java.util.Map<java.lang.String,java.lang.Object> responseObj,
                                                     java.util.Map<java.lang.String,ModelAttr> definitinMap)
                                              throws com.fasterxml.jackson.core.JsonProcessingException

处理返回值

参数:

responseObj -

抛出:

com.fasterxml.jackson.core.JsonProcessingException

processResponseModelAttrs

private static ModelAttr processResponseModelAttrs(java.util.Map<java.lang.String,java.lang.Object> responseObj,
                                                   java.util.Map<java.lang.String,ModelAttr> definitinMap)

处理返回属性列表

参数:

responseObj -

definitinMap -

processRequestParam

private static java.lang.String processRequestParam(java.util.List<Request> list)
                                             throws java.io.IOException

封装请求体

参数:

list -

抛出:

java.io.IOException

getUrlParamsByMap

public static java.lang.String getUrlParamsByMap(java.util.Map<java.lang.String,java.lang.Object> map)

将map转换成url

getHeaderByMap

public static java.lang.String getHeaderByMap(java.util.Map<java.lang.String,java.lang.Object> map)

将map转换成header

getValue

private static java.lang.Object getValue(java.lang.String type,
                                         ModelAttr modelAttr)

例子中，字段的默认值

参数:

type - 类型

modelAttr - 引用的类型

processResponseCodeList

private static java.util.List<Response> processResponseCodeList(java.util.Map<java.lang.String,java.lang.Object> responses)

处理返回码列表

参数:

responses - 全部状态码返回对象

addReqParam

private static void addReqParam(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> reqList,
                                java.lang.String firstSuffix,
                                java.lang.Object in,
                                java.util.List<ModelAttr> properties)

addResParam

private static void addResParam(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> resList,
                                java.lang.String firstSuffix,
                                java.util.List<ModelAttr> properties)

parseWordIndex

private static java.util.Map<java.lang.String,java.lang.String> parseWordIndex(java.util.Map<java.lang.String,java.lang.Object> map)

parseDefinitions

private static java.util.Map<java.lang.String,ModelAttr> parseDefinitions(java.util.Map<java.lang.String,java.lang.Object> map)

解析Definition

参数:

map -

getAndPutModelAttr

private static ModelAttr getAndPutModelAttr(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> swaggerMap,
                                            java.util.Map<java.lang.String,ModelAttr> resMap,
                                            java.lang.String modeName)

递归生成ModelAttr 对$ref类型设置具体属性