Repository: JMCuixy/SwaggerToWord
Branch: master
Commit: 0da571201671
Files: 30
Total size: 136.1 KB
Directory structure:
gitextract_o1xkyn5v/
├── .gitignore
├── LICENSE
├── README.md
├── pom.xml
└── src/
└── main/
├── java/
│ └── org/
│ └── word/
│ ├── Application.java
│ ├── config/
│ │ ├── JavaConfig.java
│ │ └── SwaggerDocumentationConfig.java
│ ├── controller/
│ │ ├── IndexController.java
│ │ ├── OpenApiWordController.java
│ │ └── WordController.java
│ ├── model/
│ │ ├── ModelAttr.java
│ │ ├── Request.java
│ │ ├── Response.java
│ │ └── Table.java
│ ├── service/
│ │ ├── OpenApiWordService.java
│ │ ├── WordService.java
│ │ └── impl/
│ │ ├── OpenApiWordServiceImpl.java
│ │ └── WordServiceImpl.java
│ └── utils/
│ ├── JsonUtils.java
│ ├── MenuUtils.java
│ ├── ModelAttrUtils.java
│ ├── RequestUtils.java
│ └── ResponseUtils.java
└── resources/
├── application.yml
├── logback.xml
└── templates/
├── index.html
├── word-en_US.html
├── word-fr_FR.html
├── word-zh_CN.html
└── word.html
================================================
FILE CONTENTS
================================================
================================================
FILE: .gitignore
================================================
.idea
/*.iml
target/
================================================
FILE: LICENSE
================================================
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
================================================
FILE: README.md
================================================
### 使用步骤（Google Chrome）
1. 启动工程，访问地址： http://127.0.0.1:8080/swagger-ui.html
2. swagger2Word 提供了多种方式生成 word 文档，可以通过 swagger json 的资源地址，例如：https://petstore.swagger.io/v2/swagger.json ；可以通过上传 json 文件；甚至可以直接输入 json 字符串。
3. 生成的 WORD 示例：
--------------版本迭代历程，感谢各位小伙伴的支持--------------
#### 版本： SwaggerToWord 1.0 （2018-01-18）
1. 一个Swagger API 文档转 Word 文档的工具项目
2. 项目想法和说明可以参考：[http://www.cnblogs.com/jmcui/p/8298823.html](http://www.cnblogs.com/jmcui/p/8298823.html)
#### 版本：SwaggerToWord 1.1 (2018-02-11)
1. 替换 HttpClient 工具类以适配更多的Restful服务。
2. 把 json 示例文件替换成官方的示例文件。
3. 更改写死的模板。让生成的 word 的内容都从 Swagger api 中来。
#### 版本：SwaggerToWord 1.2 (2018-06-21)
1. 引入了 Spring 的 RestTemplate 取代 HttpClients 以支持更多的 Restful 请求。
2. 命名规范以及增加异常处理，对于无法处理的HTTP请求返回空字符串。
3. 修改之前导入data.josn的方式，变成 restTemplate.getForObject("SwaggerJson的url地址",Map.class) 的动态获取方式。
#### 版本：SwaggerToWord 1.3 (2019-06-12)
1. Spring 框架向 SpringBoot 升级。
2. thymeleaf 取代 jsp模板。
#### 版本：SwaggerToWord 1.4 (2019-08-02)
1. 取消 HttpClient 的请求方式去获得返回值，改由从 Swagger Json 文件中直接读取
2. 针对 application/json 请求方式的入参做渲染
3. 对于文字过多导致 HTML table 变形做适配
4. 真诚感谢 [fpzhan](https://github.com/fpzhan) 的代码贡献。
##### 版本: SwaggerToWord 1.4.1 (2019-09-25)
1. 修复当请求参数为@RequestBody 时，参数类型显示不正确问题。
2. 新增直接从请求路径中获取 Swagger JSON,多项目下API文档生成。
3. 解决中文乱码问题。
4. 真诚感谢 [NealLemon](https://github.com/NealLemon) 的代码贡献。
##### 版本: SwaggerToWord 1.4.2 (2019-10-11)
1. 增加一键下载doc文件文件的方式。
2. 真诚感谢 [benwudan](https://github.com/benwudan) 的想法和代码贡献。
#### 版本：SwaggerToWord 1.5 (2019-12-18)
1. 代码梳理和页面美化。
4. 真诚感谢 [kevin4j](https://github.com/kevin4j) 的代码贡献。
================================================
FILE: pom.xml
================================================
4.0.0
org.word
Swagger2Word
jar
1.5.0-SNAPSHOT
swagger2word
org.springframework.boot
spring-boot-starter-parent
2.0.5.RELEASE
true
1.8
2.6.1
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-starter-thymeleaf
org.projectlombok
lombok
org.apache.commons
commons-lang3
org.apache.httpcomponents
httpclient
io.springfox
springfox-swagger2
${springfox-version}
io.springfox
springfox-swagger-ui
${springfox-version}
joda-time
joda-time
Swagger2Word
org.apache.maven.plugins
maven-compiler-plugin
3.3
1.8
1.8
utf-8
org.apache.maven.plugins
maven-resources-plugin
2.6
${*}
@
false
org.springframework.boot
spring-boot-maven-plugin
2.0.1.RELEASE
package
repackage
exec
org.springframework.boot
spring-boot-maven-plugin
================================================
FILE: src/main/java/org/word/Application.java
================================================
package org.word;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* @author cuixiuyin
* @description
* @date: 2018/12/19 21:32
*/
@SpringBootApplication
@EnableSwagger2
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
================================================
FILE: src/main/java/org/word/config/JavaConfig.java
================================================
package org.word.config;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.conn.ssl.TrustStrategy;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.http.converter.StringHttpMessageConverter;
import org.springframework.web.client.RestTemplate;
import javax.net.ssl.SSLContext;
import java.nio.charset.StandardCharsets;
import java.security.KeyManagementException;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.X509Certificate;
/**
* Created by XiuYin.Cui on 2018/6/21.
*/
@Configuration
public class JavaConfig {
@Bean
public RestTemplate restTemplate() throws KeyStoreException, NoSuchAlgorithmException, KeyManagementException {
TrustStrategy acceptingTrustStrategy = (X509Certificate[] chain, String authType) -> true;
SSLContext sslContext = org.apache.http.ssl.SSLContexts.custom()
.loadTrustMaterial(null, acceptingTrustStrategy)
.build();
SSLConnectionSocketFactory csf = new SSLConnectionSocketFactory(sslContext);
CloseableHttpClient httpClient = HttpClients.custom()
.setSSLSocketFactory(csf)
.build();
HttpComponentsClientHttpRequestFactory requestFactory =
new HttpComponentsClientHttpRequestFactory();
requestFactory.setHttpClient(httpClient);
//60s
requestFactory.setConnectTimeout(60 * 1000);
requestFactory.setReadTimeout(60 * 1000);
RestTemplate restTemplate = new RestTemplate(requestFactory);
restTemplate.getMessageConverters().set(1, new StringHttpMessageConverter(StandardCharsets.UTF_8));
return restTemplate;
}
}
================================================
FILE: src/main/java/org/word/config/SwaggerDocumentationConfig.java
================================================
package org.word.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import java.util.Collections;
import java.util.List;
/*
* added by dongxl6
* enable swagger-ui
*/
@Configuration
public class SwaggerDocumentationConfig {
ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Swagger to Word")
.description("a tool for converting swagger json to word")
.license("Apache 2.0")
.licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
.termsOfServiceUrl("")
.version("0.0.1")
.contact(new Contact("","", "15980292662@163.com"))
.build();
}
@Bean
public Docket customImplementation(){
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("org.word.controller"))
.build()
.directModelSubstitute(org.joda.time.LocalDate.class, java.sql.Date.class)
.directModelSubstitute(org.joda.time.DateTime.class, java.util.Date.class)
.apiInfo(apiInfo());
}
}
================================================
FILE: src/main/java/org/word/controller/IndexController.java
================================================
package org.word.controller;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.springframework.core.io.Resource;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import springfox.documentation.annotations.ApiIgnore;
import javax.servlet.http.HttpServletRequest;
/**
* @author xiuyin.cui
* @Description
* @date 2019/3/22 10:52
*/
@Controller
public class IndexController {
@ApiIgnore
@RequestMapping(value = "/")
public String index(HttpServletRequest request) {
return "redirect:swagger-ui.html";
}
}
================================================
FILE: src/main/java/org/word/controller/OpenApiWordController.java
================================================
package org.word.controller;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestPart;
import org.springframework.web.multipart.MultipartFile;
import org.thymeleaf.context.Context;
import org.thymeleaf.spring5.SpringTemplateEngine;
import org.word.service.OpenApiWordService;
import javax.servlet.http.HttpServletResponse;
import javax.validation.Valid;
import java.io.BufferedOutputStream;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.Map;
@Controller
@Api(tags = "OpenAPI")
public class OpenApiWordController {
@Value("${swagger.url}")
private String swaggerUrl;
@Autowired
private OpenApiWordService openApiWordService;
@Autowired
private SpringTemplateEngine springTemplateEngine;
private String fileName;
/**
* 将 swagger json文件转换成 word文档并下载
*
* @param model
* @param jsonFile 需要转换成 word 文档的swagger json文件
* @param response
* @return
* @throws Exception
*/
@ApiOperation(value = "将 swagger json文件转换成 word文档并下载", notes = "", tags = {"Word"})
@ApiResponses(value = {@ApiResponse(code = 200, message = "请求成功。")})
@RequestMapping(value = "/OpenApiFileToWord", method = {RequestMethod.POST})
public void getWord(Model model, @ApiParam("swagger json file") @Valid @RequestPart("jsonFile") MultipartFile jsonFile, HttpServletResponse response) throws Exception {
generateModelData(model, jsonFile);
writeContentToResponse(model, response);
}
private void generateModelData(Model model, MultipartFile jsonFile) throws IOException {
Map result = openApiWordService.tableList(jsonFile);
fileName = jsonFile.getOriginalFilename();
if (fileName != null) {
fileName = fileName.replaceAll(".json", "");
} else {
fileName = "toWord";
}
model.addAttribute("url", "http://");
model.addAttribute("download", 0);
model.addAllAttributes(result);
}
private void generateModelData(Model model, String url, Integer download) {
url = StringUtils.defaultIfBlank(url, swaggerUrl);
Map result = openApiWordService.tableList(url);
model.addAttribute("url", url);
model.addAttribute("download", download);
model.addAllAttributes(result);
}
private void writeContentToResponse(Model model, HttpServletResponse response) {
Context context = new Context();
context.setVariables(model.asMap());
String content = springTemplateEngine.process("word", context);
response.setContentType("application/octet-stream;charset=utf-8");
response.setCharacterEncoding("utf-8");
try (BufferedOutputStream bos = new BufferedOutputStream(response.getOutputStream())) {
response.setHeader("Content-disposition", "attachment;filename=" + URLEncoder.encode(fileName + ".doc", "utf-8"));
byte[] bytes = content.getBytes();
bos.write(bytes, 0, bytes.length);
bos.flush();
} catch (IOException e) {
e.printStackTrace();
}
}
}
================================================
FILE: src/main/java/org/word/controller/WordController.java
================================================
package org.word.controller;
import io.swagger.annotations.*;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RequestPart;
import org.springframework.web.multipart.MultipartFile;
import org.thymeleaf.context.Context;
import org.thymeleaf.spring5.SpringTemplateEngine;
import org.word.service.WordService;
import javax.servlet.http.HttpServletResponse;
import javax.validation.Valid;
import java.io.*;
import java.net.URLEncoder;
import java.util.Locale;
import java.util.Map;
/**
* Created by XiuYin.Cui on 2018/1/11.
*/
@Controller
@Api(tags = "the toWord API")
@Slf4j
public class WordController {
@Value("${swagger.url}")
private String swaggerUrl;
@Autowired
private WordService tableService;
@Autowired
private SpringTemplateEngine springTemplateEngine;
private String fileName = "toWord";
/**
* 将 swagger 文档转换成 html 文档，可通过在网页上右键另存为 xxx.doc 的方式转换为 word 文档
*
* @param model
* @param url 需要转换成 word 文档的资源地址
* @return
*/
@Deprecated
@ApiOperation(value = "将 swagger 文档转换成 html 文档，可通过在网页上右键另存为 xxx.doc 的方式转换为 word 文档", response = String.class, tags = {"Word"})
@ApiResponses(value = {@ApiResponse(code = 200, message = "请求成功。", response = String.class)})
@RequestMapping(value = "/toWord", method = {RequestMethod.GET})
public String getWord(Model model,
@ApiParam(value = "资源地址", required = false) @RequestParam(value = "url", required = false) String url,
@ApiParam(value = "是否下载", required = false) @RequestParam(value = "download", required = false, defaultValue = "1") Integer download) {
generateModelData(model, url, download);
// Is there a localized template available ?
Locale currentLocale = Locale.getDefault();
String localizedTemplate = "word-" + currentLocale.getLanguage() + "_" + currentLocale.getCountry();
String fileName = "/templates/" + localizedTemplate + ".html";
if (getClass().getResourceAsStream(fileName) != null) {
log.info(fileName + " resource found");
return localizedTemplate;
} else {
log.info(fileName + " resource not found, using default");
}
return "word";
}
private void generateModelData(Model model, String url, Integer download) {
url = StringUtils.defaultIfBlank(url, swaggerUrl);
Map result = tableService.tableList(url);
model.addAttribute("url", url);
model.addAttribute("download", download);
model.addAllAttributes(result);
}
/**
* 将 swagger 文档一键下载为 doc 文档
*
* @param model
* @param url 需要转换成 word 文档的资源地址
* @param response
*/
@ApiOperation(value = "将 swagger 文档一键下载为 doc 文档", notes = "", tags = {"Word"})
@ApiResponses(value = {@ApiResponse(code = 200, message = "请求成功。")})
@RequestMapping(value = "/downloadWord", method = {RequestMethod.GET})
public void word(Model model, @ApiParam(value = "资源地址", required = false) @RequestParam(required = false) String url, HttpServletResponse response) {
generateModelData(model, url, 0);
writeContentToResponse(model, response);
}
private void writeContentToResponse(Model model, HttpServletResponse response) {
Context context = new Context();
context.setVariables(model.asMap());
String content = springTemplateEngine.process("word", context);
response.setContentType("application/octet-stream;charset=utf-8");
response.setCharacterEncoding("utf-8");
try (BufferedOutputStream bos = new BufferedOutputStream(response.getOutputStream())) {
response.setHeader("Content-disposition", "attachment;filename=" + URLEncoder.encode(fileName + ".doc", "utf-8"));
byte[] bytes = content.getBytes();
bos.write(bytes, 0, bytes.length);
bos.flush();
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 将 swagger json文件转换成 word文档并下载
*
* @param model
* @param jsonFile 需要转换成 word 文档的swagger json文件
* @param response
* @return
*/
@ApiOperation(value = "将 swagger json文件转换成 word文档并下载", notes = "", tags = {"Word"})
@ApiResponses(value = {@ApiResponse(code = 200, message = "请求成功。")})
@RequestMapping(value = "/fileToWord", method = {RequestMethod.POST})
public void getWord(Model model, @ApiParam("swagger json file") @Valid @RequestPart("jsonFile") MultipartFile jsonFile, HttpServletResponse response) {
generateModelData(model, jsonFile);
writeContentToResponse(model, response);
}
/**
* 将 swagger json字符串转换成 word文档并下载
*
* @param model
* @param jsonStr 需要转换成 word 文档的swagger json字符串
* @param response
* @return
*/
@ApiOperation(value = "将 swagger json字符串转换成 word文档并下载", notes = "", tags = {"Word"})
@ApiResponses(value = {@ApiResponse(code = 200, message = "请求成功。")})
@RequestMapping(value = "/strToWord", method = {RequestMethod.POST})
public void getWord(Model model, @ApiParam("swagger json string") @Valid @RequestParam("jsonStr") String jsonStr, HttpServletResponse response) {
generateModelData(model, jsonStr);
writeContentToResponse(model, response);
}
private void generateModelData(Model model, String jsonStr) {
Map result = tableService.tableListFromString(jsonStr);
model.addAttribute("url", "http://");
model.addAttribute("download", 0);
model.addAllAttributes(result);
}
private void generateModelData(Model model, MultipartFile jsonFile) {
Map result = tableService.tableList(jsonFile);
fileName = jsonFile.getOriginalFilename();
if (fileName != null) {
fileName = fileName.replaceAll(".json", "");
} else {
fileName = "toWord";
}
model.addAttribute("url", "http://");
model.addAttribute("download", 0);
model.addAllAttributes(result);
}
}
================================================
FILE: src/main/java/org/word/model/ModelAttr.java
================================================
package org.word.model;
import lombok.Data;
import org.apache.commons.lang3.StringUtils;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
/**
* 返回属性
*
* @author kevin
*/
@Data
public class ModelAttr implements Serializable {
public String getClassName() {
return className;
}
public void setClassName(String className) {
this.className = className;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
public Boolean getRequire() {
return require;
}
public void setRequire(Boolean require) {
this.require = require;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public List getProperties() {
return properties;
}
public void setProperties(List properties) {
this.properties = properties;
}
public boolean isCompleted() {
return isCompleted;
}
public void setCompleted(boolean isCompleted) {
this.isCompleted = isCompleted;
}
public static long getSerialversionuid() {
return serialVersionUID;
}
private static final long serialVersionUID = -4074067438450613643L;
/**
* 类名
*/
private String className = StringUtils.EMPTY;
/**
* 属性名
*/
private String name = StringUtils.EMPTY;
/**
* 类型
*/
private String type = StringUtils.EMPTY;
/**
* 是否必填
*/
private Boolean require = false;
/**
* 属性描述
*/
private String description;
/**
* 嵌套属性列表
*/
private List properties = new ArrayList<>();
/**
* 是否加载完成，避免循环引用
*/
private boolean isCompleted = false;
}
================================================
FILE: src/main/java/org/word/model/Request.java
================================================
package org.word.model;
import java.io.Serializable;
import lombok.Data;
/**
* Created by XiuYin.Cui on 2018/1/11.
*/
@Data
public class Request implements Serializable{
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
public String getParamType() {
return paramType;
}
public void setParamType(String paramType) {
this.paramType = paramType;
}
public Boolean getRequire() {
return require;
}
public void setRequire(Boolean require) {
this.require = require;
}
public String getRemark() {
return remark;
}
public void setRemark(String remark) {
this.remark = remark;
}
public ModelAttr getModelAttr() {
return modelAttr;
}
public void setModelAttr(ModelAttr modelAttr) {
this.modelAttr = modelAttr;
}
/**
* 参数名
*/
private String name;
/**
* 数据类型
*/
private String type;
/**
* 参数类型
*/
private String paramType;
/**
* 是否必填
*/
private Boolean require;
/**
* 说明
*/
private String remark;
/**
* 复杂对象引用
*/
private ModelAttr modelAttr;
}
================================================
FILE: src/main/java/org/word/model/Response.java
================================================
package org.word.model;
import java.io.Serializable;
import lombok.Data;
/**
* Created by XiuYin.Cui on 2018/1/11.
*/
@Data
public class Response implements Serializable{
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getRemark() {
return remark;
}
public void setRemark(String remark) {
this.remark = remark;
}
/**
* 返回参数
*/
private String description;
/**
* 参数名
*/
private String name;
/**
* 备注
*/
private String remark;
}
================================================
FILE: src/main/java/org/word/model/Table.java
================================================
package org.word.model;
import lombok.Data;
import java.util.List;
/**
* Created by XiuYin.Cui on 2018/1/11.
*/
@Data
public class Table {
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
public String getTag() {
return tag;
}
public void setTag(String tag) {
this.tag = tag;
}
public String getUrl() {
return url;
}
public void setUrl(String url) {
this.url = url;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public String getRequestForm() {
return requestForm;
}
public void setRequestForm(String requestForm) {
this.requestForm = requestForm;
}
public String getResponseForm() {
return responseForm;
}
public void setResponseForm(String responseForm) {
this.responseForm = responseForm;
}
public String getRequestType() {
return requestType;
}
public void setRequestType(String requestType) {
this.requestType = requestType;
}
public List getRequestList() {
return requestList;
}
public void setRequestList(List requestList) {
this.requestList = requestList;
}
public List getResponseList() {
return responseList;
}
public void setResponseList(List responseList) {
this.responseList = responseList;
}
public String getRequestParam() {
return requestParam;
}
public void setRequestParam(String requestParam) {
this.requestParam = requestParam;
}
public String getResponseParam() {
return responseParam;
}
public void setResponseParam(String responseParam) {
this.responseParam = responseParam;
}
public ModelAttr getModelAttr() {
return modelAttr;
}
public void setModelAttr(ModelAttr modelAttr) {
this.modelAttr = modelAttr;
}
/**
* 大标题
*/
private String title;
/**
* 小标题
*/
private String tag;
/**
* url
*/
private String url;
/**
* 描述
*/
private String description;
/**
* 请求参数格式
*/
private String requestForm;
/**
* 响应参数格式
*/
private String responseForm;
/**
* 请求方式
*/
private String requestType;
/**
* 请求体
*/
private List requestList;
/**
* 返回体
*/
private List responseList;
/**
* 请求参数
*/
private String requestParam;
/**
* 返回参数
*/
private String responseParam;
/**
* 返回属性列表
*/
private ModelAttr modelAttr = new ModelAttr();
}
================================================
FILE: src/main/java/org/word/service/OpenApiWordService.java
================================================
package org.word.service;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
import java.util.Map;
/**
* Created by XiuYin.Cui on 2018/1/12.
*/
public interface OpenApiWordService {
Map tableList(String swaggerUrl);
Map tableListFromString(String jsonStr) throws IOException;
Map tableList(MultipartFile jsonFile) throws IOException;
}
================================================
FILE: src/main/java/org/word/service/WordService.java
================================================
package org.word.service;
import org.springframework.web.multipart.MultipartFile;
import java.util.Map;
/**
* Created by XiuYin.Cui on 2018/1/12.
*/
public interface WordService {
Map tableList(String swaggerUrl);
Map tableListFromString(String jsonStr);
Map tableList(MultipartFile jsonFile);
}
================================================
FILE: src/main/java/org/word/service/impl/OpenApiWordServiceImpl.java
================================================
package org.word.service.impl;
import com.fasterxml.jackson.core.JsonProcessingException;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.util.CollectionUtils;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.multipart.MultipartFile;
import org.word.model.ModelAttr;
import org.word.model.Request;
import org.word.model.Response;
import org.word.model.Table;
import org.word.service.OpenApiWordService;
import org.word.utils.JsonUtils;
import org.word.utils.RequestUtils;
import org.word.utils.ResponseUtils;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.TreeMap;
import java.util.stream.Collectors;
/**
* @Author XiuYin.Cui
* @Date 2018/1/12
**/
@SuppressWarnings({"unchecked", "rawtypes"})
@Slf4j
@Service
public class OpenApiWordServiceImpl implements OpenApiWordService {
@Autowired
private RestTemplate restTemplate;
@Override
public Map tableList(String swaggerUrl) {
Map resultMap = new HashMap<>();
try {
String jsonStr = restTemplate.getForObject(swaggerUrl, String.class);
resultMap = tableListFromString(jsonStr);
// log.debug(JsonUtils.writeJsonStr(resultMap));
} catch (Exception e) {
log.error("parse error", e);
}
return resultMap;
}
@Override
public Map tableListFromString(String jsonStr) throws IOException {
Map resultMap = new HashMap<>();
List result = new ArrayList<>();
try {
Map map = getResultFromString(result, jsonStr);
Map> tableMap = result.stream().parallel().collect(Collectors.groupingBy(Table::getTitle));
resultMap.put("tableMap", new TreeMap<>(tableMap));
resultMap.put("info", map.get("info"));
// log.debug(JsonUtils.writeJsonStr(resultMap));
} catch (Exception e) {
log.error("parse error", e);
throw e;
}
return resultMap;
}
@Override
public Map tableList(MultipartFile jsonFile) throws IOException {
Map resultMap = new HashMap<>();
try {
String jsonStr = new String(jsonFile.getBytes());
resultMap = tableListFromString(jsonStr);
// log.debug(JsonUtils.writeJsonStr(resultMap));
} catch (Exception e) {
log.error("parse error", e);
throw e;
}
return resultMap;
}
private Map getResultFromString(List result, String jsonStr) throws IOException {
// convert JSON string to Map
Map map = JsonUtils.readValue(jsonStr, HashMap.class);
//解析model
Map definitinMap = parseComponents(map);
//解析paths
Map> paths = (Map>) map.get("paths");
//获取全局请求参数格式作为默认请求参数格式
List defaultConsumes = (List) map.get("consumes");
//获取全局响应参数格式作为默认响应参数格式
List defaultProduces = (List) map.get("produces");
if (paths != null) {
Iterator>> it = paths.entrySet().iterator();
while (it.hasNext()) {
Entry> path = it.next();
// 0. 获取该路由下所有请求方式的公共参数
Map methods = (Map) path.getValue();
List commonParameters = (ArrayList) methods.get("parameters");
Iterator> it2 = path.getValue().entrySet().iterator();
// 1.请求路径
String url = path.getKey();
String requestType = null;
while (it2.hasNext()) {
try {
Entry request = it2.next();
// 2.请求方式，类似为 get,post,delete,put 这样
requestType = request.getKey();
if ("parameters".equals(requestType)) {
continue;
}
Map content = (Map) request.getValue();
// 4. 大标题（类说明）
String title = String.valueOf(((List) content.get("tags")).get(0));
// 5.小标题 （方法说明）
String tag = String.valueOf(content.get("operationId"));
// 6.接口描述
Object descObj = content.get("description");
String description = descObj == null ? "" : descObj.toString();
// 7. 请求体
List parameters = (ArrayList) content.get("parameters");
if (!CollectionUtils.isEmpty(parameters)) {
if (commonParameters != null) {
parameters.addAll(commonParameters);
}
} else {
if (commonParameters != null) {
parameters = commonParameters;
}
}
// 8.返回体
Map responses = (LinkedHashMap) content.get("responses");
// 9.请求参数格式，类似于 multipart/form-data
List requestParamsFormates = getRequestParamsFormate(content);
String requestForm = StringUtils.join(requestParamsFormates, ",");
// 取出来状态是200时的返回值
Map obj = (Map) responses.get("200");
Map requestBody = (Map) content.get("requestBody");
// 10.返回参数格式，类似于 application/json
List responseParamsFormates = getResponseParamsFormate(obj);
String responseForm = StringUtils.join(responseParamsFormates, ",");
//封装Table
Table table = new Table();
table.setTitle(title);
table.setUrl(url);
table.setTag(tag);
table.setDescription(description);
table.setRequestForm(requestForm);
table.setResponseForm(responseForm);
table.setRequestType(requestType);
table.setRequestList(processRequestList(parameters, requestBody, definitinMap));
table.setResponseList(processResponseCodeList(responses, definitinMap));
if (obj != null && obj.get("content") != null) {
table.setModelAttr(processResponseModelAttrs(obj, definitinMap));
}
//示例
table.setRequestParam(processRequestParam(table.getRequestList()));
table.setResponseParam(processResponseParam1(obj, definitinMap));
result.add(table);
} catch (Exception e) {
StringWriter sw = new StringWriter();
PrintWriter pw = new PrintWriter(sw);
e.printStackTrace(pw);
throw new JsonProcessingException(url + "接口格式不正确: " + requestType + "请求 " + e.getMessage()) {};
}
}
}
}
return map;
}
/**
* 请求参数格式， 类似于 multipart/form-data
*/
private List getRequestParamsFormate(Map obj) {
Map requestBody = (LinkedHashMap) obj.get("requestBody");
List requestTypes = new ArrayList();
if (requestBody != null) {
Map content = (LinkedHashMap) requestBody.get("content");
Set keys = content.keySet();
return new ArrayList(keys);
}
return requestTypes;
}
/**
* 返回参数格式，类似于 application/json
* @throws Exception
*/
private List getResponseParamsFormate(Map responseObj) {
Map content = (LinkedHashMap) responseObj.get("content");
List responseTypes = new ArrayList();
if (content != null) {
Set keys = content.keySet();
return new ArrayList(keys);
}
return responseTypes;
}
/**
* 处理请求参数列表
*
* @param parameters
* @param definitinMap
* @return
* @throws JsonProcessingException
*/
private List processRequestList(List parameters, Map requestBody, Map definitinMap) throws JsonProcessingException {
List requestList = new ArrayList<>();
if (!CollectionUtils.isEmpty(parameters)) {
for (Map param : parameters) {
Object in = param.get("in");
Request request = new Request();
request.setName(String.valueOf(param.get("name")));
Map schema1 = (Map) param.get("schema");
request.setType(schema1 == null ? " " : schema1.get("type").toString());
// request.setType(param.get("type") == null ? "object" : param.get("type").toString());
if (param.get("format") != null) {
request.setType(request.getType() + "(" + param.get("format") + ")");
}
request.setParamType(String.valueOf(in));
// 考虑对象参数类型
if (in != null && "body".equals(in)) {
Map schema = (Map) param.get("schema");
Object ref = schema.get("$ref");
// 数组情况另外处理
if (schema.get("type") != null && "array".equals(schema.get("type"))) {
ref = ((Map) schema.get("items")).get("$ref");
request.setType("array");
}
if (ref != null) {
request.setType(request.getType() + ":" + ref.toString().replaceAll("#/definitions/", ""));
request.setModelAttr(definitinMap.get(ref));
}
}
// 是否必填
request.setRequire(false);
if (param.get("required") != null) {
request.setRequire((Boolean) param.get("required"));
}
// 参数说明
request.setRemark(String.valueOf(param.get("description")));
requestList.add(request);
}
}
if (requestBody != null) {
Map content = (LinkedHashMap) requestBody.get("content");
try {
RequestUtils.validateRequestKey(content);
} catch(Exception e) {
throw new JsonProcessingException("requestybody 字段 " + e.getMessage()) {};
}
Iterator> applications = content.entrySet().iterator();
while (applications.hasNext()) {
Map.Entry application = applications.next();
if (application.getValue() != null) {
Request request = new Request();
Map schema = (Map) application.getValue().get("schema");
request.setName(" ");
request.setType(schema == null ? " " : schema.get("type").toString());
request.setParamType("body");
Object ref = schema.get("$ref");
if (schema.get("type") != null && "array".equals(schema.get("type"))) {
ref = ((Map) schema.get("items")).get("$ref");
request.setType("array");
}
if (ref != null) {
// request.setType(request.getType() + ":" + ref.toString().replaceAll("#/definitions/", ""));
request.setType("object");
request.setModelAttr(definitinMap.get(ref));
}
if (schema.get("properties") != null) {
ArrayList requiredArr = new ArrayList();
if (schema.get("required") != null) {
requiredArr = (ArrayList) schema.get("required");
}
request.setModelAttr(getRequestSchemaModelAttr(schema, requiredArr));
}
// 是否必填
request.setRequire(true);
// 参数说明
requestList.add(request);
}
}
}
return requestList;
}
/**
* 处理返回码列表
*
* @param responses 全部状态码返回对象
* @return
*/
private List processResponseCodeList(Map responses, Map definitinMap ) throws JsonProcessingException {
List responseList = new ArrayList<>();
Iterator> resIt = responses.entrySet().iterator();
while (resIt.hasNext()) {
Map.Entry entry = resIt.next();
Response response = new Response();
// 状态码 200 201 401 403 404 这样
response.setName(entry.getKey());
LinkedHashMap statusCodeInfo = (LinkedHashMap) entry.getValue();
response.setDescription(String.valueOf(statusCodeInfo.get("description")));
Map content = (Map) statusCodeInfo.get("content");
if (content != null) {
try {
ResponseUtils.validateResponseKey(content);
} catch(Exception e) {
throw new JsonProcessingException("response字段 " + entry.getKey() + "字段 " + e.getMessage()) {};
}
// responses内容application多个遍历处理
Iterator> applications = content.entrySet().iterator();
while (applications.hasNext()) {
Map.Entry application = applications.next();
if (application.getValue() != null) {
Object schema = application.getValue().get("schema");
if (schema != null) {
Object originalRef = ((LinkedHashMap) schema).get("originalRef");
response.setRemark(originalRef == null ? "" : originalRef.toString());
}
responseList.add(response);
}
}
} else {
String ref = String.valueOf(statusCodeInfo.get("$ref"));
if (ref != "") {
ModelAttr modelAttr = definitinMap.get(ref);
response.setDescription(modelAttr.getDescription());
}
responseList.add(response);
}
}
return responseList;
}
/**
* 处理返回属性列表
*
* @param responseObj
* @param definitinMap
* @return
*/
private ModelAttr processResponseModelAttrs(Map responseObj, Map definitinMap) {
Map content = (Map) responseObj.get("content");
//其他类型
ModelAttr modelAttr = new ModelAttr();
Iterator> applications = content.entrySet().iterator();
while (applications.hasNext()) {
Map.Entry application = applications.next();
if (application.getValue() != null) {
Map schema = (Map) application.getValue().get("schema");
String type = (String) schema.get("type");
String ref = null;
//数组
if ("array".equals(type)) {
Map items = (Map) schema.get("items");
if (items != null && items.get("$ref") != null) {
ref = (String) items.get("$ref");
}
}
//对象
if (schema.get("$ref") != null) {
ref = (String) schema.get("$ref");
}
//其他类型
modelAttr.setType(StringUtils.defaultIfBlank(type, StringUtils.EMPTY));
if (StringUtils.isNotBlank(ref) && definitinMap.get(ref) != null) {
modelAttr = definitinMap.get(ref);
}
// 未使用ref方式 使用properties方式
if (schema.get("properties") != null) {
modelAttr = getSchemaModelAttr(schema);
}
}
}
return modelAttr;
}
/**
* 解析components
*
* @param map
* @return
*/
private Map parseComponents(Map map) {
Map definitions = (Map) map.get("components");
Map definitinMap = new HashMap<>(256);
if (definitions != null) {
Iterator modelNameIt = definitions.keySet().iterator();
/**
"components": {
"requestBodies": {},
"schemas": {}
}
*/
while (modelNameIt.hasNext()) {
String modeName = modelNameIt.next();
/**
"schemas": {
"cat":{},
"dog":{},
}
*/
Map> modeContent = (Map>) definitions.get(modeName);
if (modeContent != null) {
Iterator modeContentIt = modeContent.keySet().iterator();
while (modeContentIt.hasNext()) {
String componentsGrandChildName = modeContentIt.next();
getAndPutModelAttr(modeContent, definitinMap, modeName, componentsGrandChildName);
}
}
}
}
return definitinMap;
}
/**
* 递归生成ModelAttr
* 对$ref类型设置具体属性
*/
private ModelAttr getAndPutModelAttr(Map> swaggerMap, Map resMap, String parentName, String modeName) {
ModelAttr modeAttr;
if ((modeAttr = resMap.get("#/components/" + parentName + "/" + modeName)) == null) {
modeAttr = new ModelAttr();
resMap.put("#/components/" + parentName + "/" + modeName, modeAttr);
} else if (resMap.get("#/components/" + parentName + "/" + modeName) != null) {
return resMap.get("#/components/" + parentName + "/" + modeName);
}
Map modeProperties = (Map) swaggerMap.get(modeName).get("properties");
List attrList = new ArrayList<>();
// 获取required字段，遍历properties添加是否必填属性
ArrayList modeRequired = (ArrayList) swaggerMap.get(modeName).get("required");
if (modeProperties != null) {
Iterator> mIt = modeProperties.entrySet().iterator();
//解析属性
while (mIt.hasNext()) {
Entry mEntry = mIt.next();
Map attrInfoMap = (Map) mEntry.getValue();
ModelAttr child = new ModelAttr();
child.setName(mEntry.getKey());
child.setType((String) attrInfoMap.get("type"));
if (attrInfoMap.get("format") != null) {
child.setType(child.getType() + "(" + attrInfoMap.get("format") + ")");
}
child.setType(StringUtils.defaultIfBlank(child.getType(), "object"));
Object ref = attrInfoMap.get("$ref");
Object items = attrInfoMap.get("items");
if (ref != null || (items != null && (ref = ((Map) items).get("$ref")) != null)) {
String refName = ref.toString();
//截取 #/components/ 后面的
String clsName = refName.substring(21);
ModelAttr refModel = getAndPutModelAttr(swaggerMap, resMap, parentName, clsName);
if (refModel != null) {
child.setProperties(refModel.getProperties());
}
child.setType(child.getType() + ":" + clsName);
}
child.setDescription((String) attrInfoMap.get("description"));
child.setRequire(false);
if (modeRequired != null && modeRequired.contains(mEntry.getKey())) {
child.setRequire(true);
}
attrList.add(child);
}
}
Object title = swaggerMap.get(modeName).get("title");
Object description = swaggerMap.get(modeName).get("description");
modeAttr.setClassName(title == null ? "" : title.toString());
modeAttr.setDescription(description == null ? "" : description.toString());
modeAttr.setProperties(attrList);
return modeAttr;
}
/**
* 递归生成ModelAttr
* 处理schema对象
* 处理requestBody直接返回属性值情况
*/
private ModelAttr getRequestSchemaModelAttr(Map schemaMap, ArrayList requiredArr) {
ModelAttr modeAttr = new ModelAttr();
Map modeProperties = (Map) schemaMap.get("properties");
if ("array".equals(schemaMap.get("type"))) {
Map items = (Map) schemaMap.get("items");
if (items != null) {
modeProperties = (Map) items.get("properties");
}
}
if (modeProperties == null) {
return null;
}
Iterator> mIt = modeProperties.entrySet().iterator();
List attrList = new ArrayList<>();
//解析属性
while (mIt.hasNext()) {
Entry mEntry = mIt.next();
Map attrInfoMap = (Map) mEntry.getValue();
ModelAttr child = new ModelAttr();
child.setName(mEntry.getKey());
child.setType((String) attrInfoMap.get("type"));
if (attrInfoMap.get("format") != null) {
child.setType(child.getType() + "(" + attrInfoMap.get("format") + ")");
}
child.setType(StringUtils.defaultIfBlank(child.getType(), "object"));
Object properties = attrInfoMap.get("properties");
Object ref = attrInfoMap.get("$ref");
Object items = attrInfoMap.get("items");
if (properties != null || (items != null)) {
ArrayList childRequiredArr = new ArrayList();
if (attrInfoMap.get("required") != null) {
childRequiredArr = (ArrayList) attrInfoMap.get("required");
}
ModelAttr refModel = getRequestSchemaModelAttr(attrInfoMap, childRequiredArr);
if (refModel != null) {
child.setProperties(refModel.getProperties());
}
child.setType((String) attrInfoMap.get("type"));
}
child.setRequire(true);
if (!requiredArr.contains(mEntry.getKey())) {
child.setRequire(false);
}
child.setDescription((String) attrInfoMap.get("description"));
attrList.add(child);
}
modeAttr.setClassName("");
modeAttr.setDescription("");
modeAttr.setProperties(attrList);
return modeAttr;
}
/**
* 递归生成ModelAttr
* 处理schema对象
* 处理responseData直接返回属性值情况
*/
private ModelAttr getSchemaModelAttr(Map schemaMap) {
ModelAttr modeAttr = new ModelAttr();
Map modeProperties = (Map) schemaMap.get("properties");
if ("array".equals(schemaMap.get("type"))) {
Map items = (Map) schemaMap.get("items");
if (items != null) {
modeProperties = (Map) items.get("properties");
}
}
if (modeProperties == null) {
return null;
}
Iterator> mIt = modeProperties.entrySet().iterator();
List attrList = new ArrayList<>();
//解析属性
while (mIt.hasNext()) {
Entry mEntry = mIt.next();
Map attrInfoMap = (Map) mEntry.getValue();
ModelAttr child = new ModelAttr();
child.setName(mEntry.getKey());
child.setType((String) attrInfoMap.get("type"));
if (attrInfoMap.get("format") != null) {
child.setType(child.getType() + "(" + attrInfoMap.get("format") + ")");
}
child.setType(StringUtils.defaultIfBlank(child.getType(), "object"));
Object properties = attrInfoMap.get("properties");
Object ref = attrInfoMap.get("$ref");
Object items = attrInfoMap.get("items");
if (properties != null || (items != null)) {
ModelAttr refModel = getSchemaModelAttr(attrInfoMap);
if (refModel != null) {
child.setProperties(refModel.getProperties());
}
child.setType((String) attrInfoMap.get("type"));
}
child.setDescription((String) attrInfoMap.get("description"));
attrList.add(child);
}
modeAttr.setClassName("");
modeAttr.setDescription("");
modeAttr.setProperties(attrList);
return modeAttr;
}
/**
* 处理返回值
*
* @param responseObj
* @return
*/
private String processResponseParam(Map responseObj, Map definitinMap) throws JsonProcessingException {
Map content = (Map) responseObj.get("content");
if (content != null) {
Iterator> applications = content.entrySet().iterator();
while (applications.hasNext()) {
Map.Entry application = applications.next();
if (application.getValue() != null) {
Map applicationContent = (Map) application.getValue();
if (applicationContent != null) {
Map schema = (Map) applicationContent.get("schema");
String type = (String) schema.get("type");
String ref = null;
// 数组
if ("array".equals(type)) {
Map items = (Map) schema.get("items");
if (items != null && items.get("$ref") != null) {
ref = (String) items.get("$ref");
}
}
// 对象ref
if (schema.get("$ref") != null) {
ref = (String) schema.get("$ref");
}
if (StringUtils.isNotEmpty(ref)) {
ModelAttr modelAttr = definitinMap.get(ref);
if (modelAttr != null && !CollectionUtils.isEmpty(modelAttr.getProperties())) {
Map responseMap = new HashMap<>(8);
for (ModelAttr subModelAttr : modelAttr.getProperties()) {
responseMap.put(subModelAttr.getName(), getValue(subModelAttr.getType(), subModelAttr));
}
return JsonUtils.writeJsonStr(responseMap);
}
}
if (schema.get("properties") != null) {
ModelAttr modelAttr = getSchemaModelAttr(schema);
if (modelAttr != null) {
Map responseMap = new HashMap<>(8);
for (ModelAttr subModelAttr : modelAttr.getProperties()) {
responseMap.put(subModelAttr.getName(), getValue(subModelAttr.getType(), subModelAttr));
}
return JsonUtils.writeJsonStr(responseMap);
}
}
}
}
}
}
return StringUtils.EMPTY;
}
private String processResponseParam1(Map responseObj, Map definitinMap) throws JsonProcessingException {
Map content = (Map) responseObj.get("content");
// if (responseObj != null && content.get("application/json") != null) {
if (content != null) {
Iterator> applications = content.entrySet().iterator();
while (applications.hasNext()) {
Map.Entry application = applications.next();
if (application.getValue() != null) {
Map> applicationContent = (Map>) application.getValue();
if (applicationContent != null) {
Map examples = (Map) applicationContent.get("examples");
if (examples != null) {
Map responseData = examples.get("response");
if (responseData != null) {
Object value = responseData.get("value");
return JsonUtils.writeJsonStr(value);
}
} else {
return "";
}
}
}
}
}
return StringUtils.EMPTY;
}
/**
* 封装请求体
*
* @param list
* @return
*/
private String processRequestParam(List list) throws IOException {
Map headerMap = new LinkedHashMap<>();
Map queryMap = new LinkedHashMap<>();
Map jsonMap = new LinkedHashMap<>();
if (list != null && list.size() > 0) {
for (Request request : list) {
String name = request.getName();
String paramType = request.getParamType();
Object value = getValue(request.getType(), request.getModelAttr());
switch (paramType) {
case "header":
headerMap.put(name, value);
break;
case "query":
queryMap.put(name, value);
break;
case "path":
queryMap.put(name, value);
break;
case "body":
//TODO 根据content-type序列化成不同格式，目前只用了json
jsonMap.put(name, value);
break;
default:
break;
}
}
}
String res = "";
if (!queryMap.isEmpty()) {
res += getUrlParamsByMap(queryMap);
}
if (!headerMap.isEmpty()) {
res += " " + getHeaderByMap(headerMap);
}
if (!jsonMap.isEmpty()) {
if (jsonMap.size() == 1) {
for (Entry entry : jsonMap.entrySet()) {
res += " '" + JsonUtils.writeJsonStr(entry.getValue()) + "'";
}
} else {
res += " '" + JsonUtils.writeJsonStr(jsonMap) + "'";
}
}
return res;
}
/**
* 例子中，字段的默认值
*
* @param type 类型
* @param modelAttr 引用的类型
* @return
*/
private Object getValue(String type, ModelAttr modelAttr) {
int pos;
if ((pos = type.indexOf(":")) != -1) {
type = type.substring(0, pos);
}
switch (type) {
case "string":
return "string";
case "string(date-time)":
return "2020/01/01 00:00:00";
case "integer":
case "integer(int64)":
case "integer(int32)":
return 0;
case "number":
return 0.0;
case "boolean":
return true;
case "file":
return "(binary)";
case "array":
List list = new ArrayList();
Map map = new LinkedHashMap<>();
if (modelAttr != null && !CollectionUtils.isEmpty(modelAttr.getProperties())) {
for (ModelAttr subModelAttr : modelAttr.getProperties()) {
map.put(subModelAttr.getName(), getValue(subModelAttr.getType(), subModelAttr));
}
}
list.add(map);
return list;
case "object":
map = new LinkedHashMap<>();
if (modelAttr != null && !CollectionUtils.isEmpty(modelAttr.getProperties())) {
for (ModelAttr subModelAttr : modelAttr.getProperties()) {
map.put(subModelAttr.getName(), getValue(subModelAttr.getType(), subModelAttr));
}
}
return map;
default:
return null;
}
}
/**
* 将map转换成url
*/
public static String getUrlParamsByMap(Map map) {
if (map == null || map.isEmpty()) {
return "";
}
StringBuffer sb = new StringBuffer();
for (Map.Entry entry : map.entrySet()) {
sb.append(entry.getKey() + "=" + entry.getValue());
sb.append("&");
}
String s = sb.toString();
if (s.endsWith("&")) {
s = StringUtils.substringBeforeLast(s, "&");
}
return s;
}
/**
* 将map转换成header
*/
public static String getHeaderByMap(Map map) {
if (map == null || map.isEmpty()) {
return "";
}
StringBuffer sb = new StringBuffer();
for (Map.Entry entry : map.entrySet()) {
sb.append("--header '");
sb.append(entry.getKey() + ":" + entry.getValue());
sb.append("'");
}
return sb.toString();
}
}
================================================
FILE: src/main/java/org/word/service/impl/WordServiceImpl.java
================================================
package org.word.service.impl;
import com.fasterxml.jackson.core.JsonProcessingException;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.util.CollectionUtils;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.multipart.MultipartFile;
import org.word.model.ModelAttr;
import org.word.model.Request;
import org.word.model.Response;
import org.word.model.Table;
import org.word.service.WordService;
import org.word.utils.JsonUtils;
import java.io.IOException;
import java.util.*;
import java.util.Map.Entry;
import java.util.stream.Collectors;
/**
* @Author XiuYin.Cui
* @Date 2018/1/12
**/
@SuppressWarnings({"unchecked", "rawtypes"})
@Slf4j
@Service
public class WordServiceImpl implements WordService {
@Autowired
private RestTemplate restTemplate;
@Override
public Map tableList(String swaggerUrl) {
Map resultMap = new HashMap<>();
try {
String jsonStr = restTemplate.getForObject(swaggerUrl, String.class);
resultMap = tableListFromString(jsonStr);
log.debug(JsonUtils.writeJsonStr(resultMap));
} catch (Exception e) {
log.error("parse error", e);
}
return resultMap;
}
@Override
public Map tableListFromString(String jsonStr) {
Map resultMap = new HashMap<>();
List result = new ArrayList<>();
try {
Map map = getResultFromString(result, jsonStr);
Map> tableMap = result.stream().parallel().collect(Collectors.groupingBy(Table::getTitle));
resultMap.put("tableMap", new TreeMap<>(tableMap));
resultMap.put("info", map.get("info"));
log.debug(JsonUtils.writeJsonStr(resultMap));
} catch (Exception e) {
log.error("parse error", e);
}
return resultMap;
}
@Override
public Map tableList(MultipartFile jsonFile) {
Map resultMap = new HashMap<>();
List result = new ArrayList<>();
try {
String jsonStr = new String(jsonFile.getBytes());
resultMap = tableListFromString(jsonStr);
log.debug(JsonUtils.writeJsonStr(resultMap));
} catch (Exception e) {
log.error("parse error", e);
}
return resultMap;
}
// 处理方案一： 同一路由下所有请求方式合并为一个表格
private Map getResultFromString(List result, String jsonStr) throws IOException {
// convert JSON string to Map
Map map = JsonUtils.readValue(jsonStr, HashMap.class);
//解析model
Map definitinMap = parseDefinitions(map);
//解析paths
Map> paths = (Map>) map.get("paths");
if (paths != null) {
Iterator>> it = paths.entrySet().iterator();
while (it.hasNext()) {
Entry> path = it.next();
Iterator> it2 = path.getValue().entrySet().iterator();
// 1.请求路径
String url = path.getKey();
// 2. 循环解析每个子节点，适应同一个路径几种请求方式的场景
while (it2.hasNext()) {
Entry request = it2.next();
// 2. 请求方式，类似为 get,post,delete,put 这样
String requestType = request.getKey();
Map content = (Map) request.getValue();
// 4. 大标题（类说明）
String title = String.valueOf(((List) content.get("tags")).get(0));
// 5.小标题 （方法说明）
String tag = String.valueOf(content.get("summary"));
// 6.接口描述
String description = String.valueOf(content.get("summary"));
// 7.请求参数格式，类似于 multipart/form-data
String requestForm = "";
List consumes = (List) content.get("consumes");
if (consumes != null && consumes.size() > 0) {
requestForm = StringUtils.join(consumes, ",");
}
// 8.返回参数格式，类似于 application/json
String responseForm = "";
List produces = (List) content.get("produces");
if (produces != null && produces.size() > 0) {
responseForm = StringUtils.join(produces, ",");
}
// 9. 请求体
List parameters = (ArrayList) content.get("parameters");
// 10.返回体
Map responses = (LinkedHashMap) content.get("responses");
//封装Table
Table table = new Table();
table.setTitle(title);
table.setUrl(url);
table.setTag(tag);
table.setDescription(description);
table.setRequestForm(requestForm);
table.setResponseForm(responseForm);
table.setRequestType(requestType);
table.setRequestList(processRequestList(parameters, definitinMap));
table.setResponseList(processResponseCodeList(responses));
// 取出来状态是200时的返回值
Map obj = (Map) responses.get("200");
if (obj != null && obj.get("schema") != null) {
table.setModelAttr(processResponseModelAttrs(obj, definitinMap));
}
//示例
table.setRequestParam(processRequestParam(table.getRequestList()));
table.setResponseParam(processResponseParam(obj, definitinMap));
result.add(table);
}
}
}
return map;
}
// 处理方案二： 新增： 同一路由下所有请求方式单独为一个表格
/*private Map getResultFromString(List result, String jsonStr) throws IOException {
// convert JSON string to Map
Map map = JsonUtils.readValue(jsonStr, HashMap.class);
//解析model
Map definitinMap = parseDefinitions(map);
//解析paths
Map> paths = (Map>) map.get("paths");
//获取全局请求参数格式作为默认请求参数格式
List defaultConsumes = (List) map.get("consumes");
//获取全局响应参数格式作为默认响应参数格式
List defaultProduces = (List) map.get("produces");
if (paths != null) {
Iterator>> it = paths.entrySet().iterator();
while (it.hasNext()) {
Entry> path = it.next();
// 0. 获取该路由下所有请求方式的公共参数
Map methods = (Map) path.getValue();
List commonParameters = (ArrayList) methods.get("parameters");
Iterator> it2 = path.getValue().entrySet().iterator();
// 1.请求路径
String url = path.getKey();
while (it2.hasNext()) {
Entry request = it2.next();
// 2.请求方式，类似为 get,post,delete,put 这样
String requestType = request.getKey();
if ("parameters".equals(requestType)) {
continue;
}
Map content = (Map) request.getValue();
// 4. 大标题（类说明）
String title = String.valueOf(((List) content.get("tags")).get(0));
// 5.小标题 （方法说明）
String tag = String.valueOf(content.get("operationId"));
// 6.接口描述
String description = String.valueOf(content.get("description"));
// 7.请求参数格式，类似于 multipart/form-data
String requestForm = "";
List consumes = (List) content.get("consumes");
if (consumes != null && consumes.size() > 0) {
requestForm = StringUtils.join(consumes, ",");
} else {
requestForm = StringUtils.join(defaultConsumes, ",");
}
// 8.返回参数格式，类似于 application/json
String responseForm = "";
List produces = (List) content.get("produces");
if (produces != null && produces.size() > 0) {
responseForm = StringUtils.join(produces, ",");
} else {
responseForm = StringUtils.join(defaultProduces, ",");
}
// 9. 请求体
List parameters = (ArrayList) content.get("parameters");
if (!CollectionUtils.isEmpty(parameters)) {
if (commonParameters != null) {
parameters.addAll(commonParameters);
}
} else {
if (commonParameters != null) {
parameters = commonParameters;
}
}
// 10.返回体
Map responses = (LinkedHashMap) content.get("responses");
//封装Table
Table table = new Table();
table.setTitle(title);
table.setUrl(url);
table.setTag(tag);
table.setDescription(description);
table.setRequestForm(requestForm);
table.setResponseForm(responseForm);
table.setRequestType(requestType);
table.setRequestList(processRequestList(parameters, definitinMap));
table.setResponseList(processResponseCodeList(responses));
// 取出来状态是200时的返回值
Map obj = (Map) responses.get("200");
if (obj != null && obj.get("schema") != null) {
table.setModelAttr(processResponseModelAttrs(obj, definitinMap));
}
//示例
table.setRequestParam(processRequestParam(table.getRequestList()));
table.setResponseParam(processResponseParam(obj, definitinMap));
result.add(table);
}
}
}
return map;
}*/
/**
* 处理请求参数列表
*
* @param parameters
* @param definitinMap
* @return
*/
private List processRequestList(List parameters, Map definitinMap) {
List requestList = new ArrayList<>();
if (!CollectionUtils.isEmpty(parameters)) {
for (Map param : parameters) {
Object in = param.get("in");
Request request = new Request();
request.setName(String.valueOf(param.get("name")));
request.setType(param.get("type") == null ? "object" : param.get("type").toString());
if (param.get("format") != null) {
request.setType(request.getType() + "(" + param.get("format") + ")");
}
request.setParamType(String.valueOf(in));
// 考虑对象参数类型
if (in != null && "body".equals(in)) {
request.setType(String.valueOf(in));
Map schema = (Map) param.get("schema");
Object ref = schema.get("$ref");
// 数组情况另外处理
if (schema.get("type") != null && "array".equals(schema.get("type"))) {
ref = ((Map) schema.get("items")).get("$ref");
request.setType("array");
}
if (ref != null) {
request.setType(request.getType() + ":" + ref.toString().replaceAll("#/definitions/", ""));
request.setModelAttr(definitinMap.get(ref));
}
}
// 是否必填
request.setRequire(false);
if (param.get("required") != null) {
request.setRequire((Boolean) param.get("required"));
}
// 参数说明
request.setRemark(String.valueOf(param.get("description")));
requestList.add(request);
}
}
return requestList;
}
/**
* 处理返回码列表
*
* @param responses 全部状态码返回对象
* @return
*/
private List processResponseCodeList(Map responses) {
List responseList = new ArrayList<>();
Iterator> resIt = responses.entrySet().iterator();
while (resIt.hasNext()) {
Map.Entry entry = resIt.next();
Response response = new Response();
// 状态码 200 201 401 403 404 这样
response.setName(entry.getKey());
LinkedHashMap statusCodeInfo = (LinkedHashMap) entry.getValue();
response.setDescription(String.valueOf(statusCodeInfo.get("description")));
Object schema = statusCodeInfo.get("schema");
if (schema != null) {
Object originalRef = ((LinkedHashMap) schema).get("originalRef");
response.setRemark(originalRef == null ? "" : originalRef.toString());
}
responseList.add(response);
}
return responseList;
}
/**
* 处理返回属性列表
*
* @param responseObj
* @param definitinMap
* @return
*/
private ModelAttr processResponseModelAttrs(Map responseObj, Map definitinMap) {
Map schema = (Map) responseObj.get("schema");
String type = (String) schema.get("type");
String ref = null;
//数组
if ("array".equals(type)) {
Map items = (Map) schema.get("items");
if (items != null && items.get("$ref") != null) {
ref = (String) items.get("$ref");
}
}
//对象
if (schema.get("$ref") != null) {
ref = (String) schema.get("$ref");
}
//其他类型
ModelAttr modelAttr = new ModelAttr();
modelAttr.setType(StringUtils.defaultIfBlank(type, StringUtils.EMPTY));
if (StringUtils.isNotBlank(ref) && definitinMap.get(ref) != null) {
modelAttr = definitinMap.get(ref);
}
return modelAttr;
}
/**
* 解析Definition
*
* @param map
* @return
*/
private Map parseDefinitions(Map map) {
Map> definitions = (Map>) map.get("definitions");
Map definitinMap = new HashMap<>(256);
if (definitions != null) {
Iterator modelNameIt = definitions.keySet().iterator();
while (modelNameIt.hasNext()) {
String modeName = modelNameIt.next();
getAndPutModelAttr(definitions, definitinMap, modeName);
}
}
return definitinMap;
}
/**
* 递归生成ModelAttr
* 对$ref类型设置具体属性
*/
private ModelAttr getAndPutModelAttr(Map> swaggerMap, Map resMap, String modeName) {
ModelAttr modeAttr;
if ((modeAttr = resMap.get("#/definitions/" + modeName)) == null) {
modeAttr = new ModelAttr();
resMap.put("#/definitions/" + modeName, modeAttr);
} else if (modeAttr.isCompleted()) {
return resMap.get("#/definitions/" + modeName);
}
Map modeProperties = (Map