com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of knife4j-spring Show documentation
Show all versions of knife4j-spring Show documentation
依赖Springfox框架,生成Spring的增强文档
The newest version!
/*
* Copyright (C) 2018 Zhejiang xiaominfo Technology CO.,LTD.
* All rights reserved.
* Official Web Site: http://www.xiaominfo.com.
* Developer Web Site: http://open.xiaominfo.com.
*/
package com.github.xiaoymin.knife4j.spring.extension;
import com.github.xiaoymin.knife4j.core.extend.OpenApiExtendMarkdownChildren;
import com.github.xiaoymin.knife4j.core.extend.OpenApiExtendMarkdownFile;
import com.github.xiaoymin.knife4j.core.extend.OpenApiExtendSetting;
import com.github.xiaoymin.knife4j.core.model.MarkdownProperty;
import com.github.xiaoymin.knife4j.core.util.CollectionUtils;
import com.github.xiaoymin.knife4j.core.util.CommonUtils;
import com.github.xiaoymin.knife4j.core.util.StrUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import springfox.documentation.service.VendorExtension;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* @author [email protected]
* 2020/10/24 7:17
* @since:knife4j 2.0.6
*/
public class OpenApiExtensionResolver {
Logger logger= LoggerFactory.getLogger(OpenApiExtensionResolver.class);
private final ResourcePatternResolver resourceResolver = new PathMatchingResourcePatternResolver();
private final Map> markdownFileMaps=new HashMap<>();
/**
* 个性化配置
*/
private final OpenApiExtendSetting setting;
/**
* 分组文档集合
*/
private final List markdownProperties;
private void start(){
if (logger.isDebugEnabled()){
logger.debug("Resolver method start...");
}
//初始化其他文档
//其他文档是否为空
if (CollectionUtils.isNotEmpty(this.markdownProperties)){
for (MarkdownProperty markdownProperty:this.markdownProperties){
if (StrUtil.isNotBlank(markdownProperty.getName())&&StrUtil.isNotBlank(markdownProperty.getLocations())){
String swaggerGroupName=StrUtil.isNotBlank(markdownProperty.getGroup())?markdownProperty.getGroup():"default";
OpenApiExtendMarkdownFile openApiExtendMarkdownFile=new OpenApiExtendMarkdownFile();
openApiExtendMarkdownFile.setName(markdownProperty.getName());
List allChildrenLists=new ArrayList<>();
//多个location以分号(;)进行分隔
String[] locations=markdownProperty.getLocations().split(";");
if (!CollectionUtils.isEmpty(locations)){
for (String location:locations){
if (StrUtil.isNotBlank(location)){
List childrenList=readLocations(location);
if (CollectionUtils.isNotEmpty(childrenList)){
allChildrenLists.addAll(childrenList);
}
}
}
}
if (CollectionUtils.isNotEmpty(allChildrenLists)){
openApiExtendMarkdownFile.setChildren(allChildrenLists);
}
//判断是否存在
if (markdownFileMaps.containsKey(swaggerGroupName)){
markdownFileMaps.get(swaggerGroupName).add(openApiExtendMarkdownFile);
}else{
markdownFileMaps.put(swaggerGroupName,CollectionUtils.newArrayList(openApiExtendMarkdownFile));
}
}
}
}
//判断主页文档
if (this.setting!=null){
if (this.setting.isEnableHomeCustom()){
if (StrUtil.isNotBlank(this.setting.getHomeCustomLocation())){
String content=readCustomHome(this.setting.getHomeCustomLocation());
//赋值
this.setting.setHomeCustomLocation(content);
}
}
}
}
/**
* 读取自定义主页markdown的内容
* @param customHomeLocation 路径
* @return markdown内容
*/
private String readCustomHome(String customHomeLocation){
String customHomeContent="";
try{
Resource[] resources=resourceResolver.getResources(customHomeLocation);
if(resources!=null&&resources.length>0){
//取第1个
Resource resource=resources[0];
customHomeContent=new String(CommonUtils.readBytes(resource.getInputStream()),"UTF-8");
}
}catch (Exception e){
logger.warn("(Ignores) Failed to read CustomeHomeLocation Markdown files,Error Message:{} ",e.getMessage());
}
return customHomeContent;
}
/**
* 根据路径读取markdown文件
* @param locations markdown文件路径
* @return 文档集合
*/
private List readLocations(String locations){
try{
List openApiExtendMarkdownChildrenList=new ArrayList<>();
Resource[] resources=resourceResolver.getResources(locations);
if (resources!=null&&resources.length>0){
for (Resource resource:resources){
OpenApiExtendMarkdownChildren markdownFile=readMarkdownChildren(resource);
if (markdownFile!=null){
openApiExtendMarkdownChildrenList.add(markdownFile);
}
}
return openApiExtendMarkdownChildrenList;
}
}catch (Exception e){
logger.warn("(Ignores) Failed to read Markdown files,Error Message:{} ",e.getMessage());
}
return null;
}
private OpenApiExtendMarkdownChildren readMarkdownChildren(Resource resource){
try{
if (resource!=null){
OpenApiExtendMarkdownChildren markdownFile=new OpenApiExtendMarkdownChildren();
if (logger.isDebugEnabled()){
logger.debug("read file:"+resource.getFilename());
}
//只读取md
if (resource.getFilename().toLowerCase().endsWith(".md")){
BufferedReader reader=null;
try {
reader=new BufferedReader(new InputStreamReader(resource.getInputStream(),"UTF-8"));
String le=null;
String title=resource.getFilename();
String reg="#{1,3}\\s{1}(.*)";
Pattern pattern=Pattern.compile(reg,Pattern.CASE_INSENSITIVE);
Matcher matcher=null;
while ((le=reader.readLine())!=null){
//判断line是否是包含标题
matcher=pattern.matcher(le);
if (matcher.matches()){
title=matcher.group(1);
}
break;
}
markdownFile.setTitle(title);
markdownFile.setContent(new String(CommonUtils.readBytes(resource.getInputStream()),"UTF-8"));
return markdownFile;
} catch (Exception e) {
logger.warn("(Ignores) Failed to read Markdown files,Error Message:{} ",e.getMessage());
}finally {
CommonUtils.closeQuiltly(reader);
}
}
}
}catch (Exception e){
logger.warn("(Ignores) Failed to read Markdown files,Error Message:{} ",e.getMessage());
}
return null;
}
/**
* 构造扩展插件
* @param groupName Swagger分组名称
* @return 扩展插件集合
*/
public List buildExtensions(String groupName){
String swaggerGroupName=StrUtil.isNotBlank(groupName)?groupName:"default";
//OpenApiExtension openApiExtension=new OpenApiExtension(OpenApiExtension.EXTENSION_NAME);
//增加Markdown和setting
//openApiExtension.addProperty(new OpenApiSettingExtension(this.setting));
//openApiExtension.addProperty(new OpenApiMarkdownExtension(markdownFileMaps.get(swaggerGroupName)));
List vendorExtensions=new ArrayList<>();
vendorExtensions.add(new OpenApiSettingExtension(OpenApiSettingExtension.SETTING_EXTENSION_NAME,CollectionUtils.newArrayList(this.setting)));
vendorExtensions.add(new OpenApiMarkdownExtension(OpenApiMarkdownExtension.MARKDOWN_EXTENSION_NAME,markdownFileMaps.get(swaggerGroupName)));
return vendorExtensions;
}
/**
* 构建个性化增强插件，个性化增强配置无需传递分组名称
* @return 扩展插件集合
*/
public List buildSettingExtensions(){
List vendorExtensions=new ArrayList<>();
vendorExtensions.add(new OpenApiSettingExtension(OpenApiSettingExtension.SETTING_EXTENSION_NAME,CollectionUtils.newArrayList(this.setting)));
return vendorExtensions;
}
public OpenApiExtensionResolver(OpenApiExtendSetting setting, List markdownProperties) {
this.setting = setting;
this.markdownProperties = markdownProperties;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy