• Home
• com.gitee.fufu669
• cache-fetch-later
• 6.666.66009
• source code
• CacheSwaggerToWikiUtil.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.gitee.fufu669.utils.CacheSwaggerToWikiUtil Maven / Gradle / Ivy

package com.gitee.fufu669.utils;

import com.gitee.fufu669.aspect.Logging;
import com.gitee.fufu669.utils.vo.SwaggerApiDocsVo;
import io.swagger.annotations.ApiParam;
import org.apache.poi.xwpf.model.XWPFHeaderFooterPolicy;
import org.apache.poi.xwpf.usermodel.*;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestParam;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.OutputStream;
import java.math.BigInteger;
import java.util.List;
import java.util.Map;

public class CacheSwaggerToWikiUtil implements Logging {

    public static final Logger logger = LoggerFactory.getLogger(CacheSwaggerToWikiUtil.class);

    public static void info(
            @ApiParam(value = "serverUrl，比如你的swagger地址是http://192.168.22.183:5000/swagger-ui.html，那么这里就填入http://192.168.22.183:5000") @RequestParam(value = "serverUrl", required = false, defaultValue = "http://localhost:10666") String serverUrl,
            @ApiParam(value = "showServerUrl，用来展示在wiki中的服务器的路径，比如http://www.test.com") @RequestParam(value = "showServerUrl", required = false, defaultValue = "http://localhost:10666") String showServerUrl,
            HttpServletRequest request,
            HttpServletResponse response
    ) {
        String swaggerUrl = serverUrl+"/v2/api-docs";
        getSwagger(swaggerUrl,showServerUrl,request,response);
    }

    public static void getSwagger(String swaggerUrl, String showServerUrl, HttpServletRequest request, HttpServletResponse response) {
        String swaggerString = CacheHttpUtil.get(swaggerUrl);
        if (StringUtils.isEmpty(swaggerString)) {
            return;
        }
        swaggerString = swaggerString.replaceAll("\\$ref", "ref");
        //logger.info(swaggerString);
        SwaggerApiDocsVo swaggerApiDocsVo = CacheJsonUtil.toObject(swaggerString, SwaggerApiDocsVo.class);
        try {
            XWPFDocument xwpfDocument = new XWPFDocument();
            // 创建Word文件
            CTSectPr sectPr = xwpfDocument.getDocument().getBody().addNewSectPr();
            XWPFHeaderFooterPolicy policy = new XWPFHeaderFooterPolicy(xwpfDocument, sectPr);
            //添加页眉
            CTP ctpHeader = CTP.Factory.newInstance();
            CTR ctrHeader = ctpHeader.addNewR();
            CTText ctHeader = ctrHeader.addNewT();
            String headerText = "swagger";
            ctHeader.setStringValue(headerText);
            XWPFParagraph headerParagraph = new XWPFParagraph(ctpHeader, xwpfDocument);
            //设置为右对齐
            headerParagraph.setAlignment(ParagraphAlignment.RIGHT);
            XWPFParagraph[] parsHeader = new XWPFParagraph[1];
            parsHeader[0] = headerParagraph;
            policy.createHeader(XWPFHeaderFooterPolicy.DEFAULT, parsHeader);
            //添加页脚
            CTP ctpFooter = CTP.Factory.newInstance();
            CTR ctrFooter = ctpFooter.addNewR();
            CTText ctFooter = ctrFooter.addNewT();
            String footerText = "swagger";
            ctFooter.setStringValue(footerText);
            XWPFParagraph footerParagraph = new XWPFParagraph(ctpFooter, xwpfDocument);
            headerParagraph.setAlignment(ParagraphAlignment.CENTER);
            XWPFParagraph[] parsFooter = new XWPFParagraph[1];
            parsFooter[0] = footerParagraph;
            policy.createFooter(XWPFHeaderFooterPolicy.DEFAULT, parsFooter);

            String topTitle = swaggerApiDocsVo.getInfo().getTitle();
            writeBoldText(xwpfDocument, topTitle, 26, "Heading1");
            String topDescription = swaggerApiDocsVo.getInfo().getDescription();
            writeText(xwpfDocument, topDescription, 6);
            Map mapLicense = swaggerApiDocsVo.getInfo().getLicense();
            Map definitions = (Map) swaggerApiDocsVo.getDefinitions();
            writeText(xwpfDocument, "协议: " + mapLicense.get("name") + " " + mapLicense.get("url"), 6);
            writeText(xwpfDocument, "版本: " + swaggerApiDocsVo.getInfo().getVersion(), 6);
            writeText(xwpfDocument, "服务需知: " + swaggerApiDocsVo.getInfo().getTermsOfService(), 6);
            writeText(xwpfDocument, "swagger版本: " + swaggerApiDocsVo.getSwagger(), 6);

            writeAllDefinitions(xwpfDocument, definitions);
            Integer index = 1;
            for (SwaggerApiDocsVo.Tag tag : swaggerApiDocsVo.getTags()) {
                writeText(xwpfDocument, "", 6);
                index += 1;
                writeBoldText(xwpfDocument, index + ".0 " + "Controller: " + tag.getName(), 12, "Heading2");
                writeBoldText(xwpfDocument, "功能描述: " + tag.getDescription(), 12, null);
                writeText(xwpfDocument, "", 6);
                Integer subIndex = 0;
                for (Map.Entry entry : swaggerApiDocsVo.getPaths().entrySet()) {
                    Map getPostValue = (Map) entry.getValue();
                    for (Map.Entry entryGetPostValue : getPostValue.entrySet()) {
                        Map getPostValueDetail = (Map) entryGetPostValue.getValue();
                        List tags = (List) getPostValueDetail.get("tags");
                        if (tags.contains(tag.getName())) {
                            subIndex += 1;
                            writeBoldText(xwpfDocument, index + "." + subIndex + " 接口路径: " + (StringUtils.isEmpty(showServerUrl) ? "http://"+ swaggerApiDocsVo.getHost():showServerUrl) + entry.getKey(), 8, "Heading3");
                            writeText(xwpfDocument, "方法类型: " + entryGetPostValue.getKey(), 6);
                            writeText(xwpfDocument, "消费类型: " + CacheJsonUtil.toJson(getPostValueDetail.get("consumes")), 6);
                            writeText(xwpfDocument, "生产类型: " + CacheJsonUtil.toJson(getPostValueDetail.get("produces")), 6);
                            writeText(xwpfDocument, "接口描述: " + getPostValueDetail.get("summary"), 6);
                            //参数列表
                            //parameters
                            writeParams(xwpfDocument, getPostValueDetail);
                            writeBoldText(xwpfDocument, "出参: ", 7, null);
                            Map responseMap = (Map) getPostValueDetail.get("responses");
                            writeOutPutResponse(xwpfDocument, responseMap, definitions);
                            writeBoldText(xwpfDocument, "返回详情: ", 7, null);
                            writeResponseDetail(xwpfDocument, responseMap, definitions);
                            writeText(xwpfDocument, "", 6);
                        }
                    }
                }
            }
            //xwpfDocument.createTOC();
            try {
                response.setCharacterEncoding("utf-8");
                //                response.setContentType("multipart/form-data");
                response.setContentType("application/x-download");
                response.setHeader("Content-Disposition", "attachment;filename=swagger_to_wiki_" + CachePasswordUtil.generateTokenNumberMilliSeconds() + ".doc");
                response.addHeader("Pargam", "no-cache");
                response.addHeader("Cache-Control", "no-cache");
            } catch (Exception ex) {
                ex.printStackTrace();
            }
            OutputStream outputStream = response.getOutputStream();
            xwpfDocument.write(outputStream);
            outputStream.flush();
            outputStream.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static void  writeAllDefinitions(XWPFDocument xwpfDocument, Map definitions) {
        writeText(xwpfDocument, "", 6);
        writeBoldText(xwpfDocument, "1.0 所有对象的定义", 12, "Heading2");
        if (definitions == null) {
            return;
        }
        int subIndex = 1;
        for (Map.Entry entry : definitions.entrySet()) {
            if (!entry.getKey().contains("单值返回")) {
                writeText(xwpfDocument, "", 6);
                writeBoldText(xwpfDocument, "1." + subIndex + " " + entry.getKey(), 7, "Heading3");
                writeDefinitions(xwpfDocument, (Map) entry.getValue());
                subIndex += 1;
            }
        }
        writeText(xwpfDocument, "", 6);
    }

    public static void  writeParams(XWPFDocument xwpfDocument, Map getPostValueDetail) {
        List