manager/zyplayer-doc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

swagger查看页面的各种优化，替换首页原有文档入口

Browse Source
This commit is contained in:
暮光：城中城
2021-10-30 19:52:28 +08:00
parent 59ecaf4477
commit c8f570fa6a
46 changed files with 392 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

147
zyplayer-doc-ui/swagger-ui/src/assets/utils/SwaggerAnalysisV2.js
View File

@@ -1,6 +1,6 @@
import {message} from 'ant-design-vue';
// 无需特殊处理的参数类型
let notNeedHandleTypeArr = ['file', 'string', 'integer', 'long', 'double', 'object', 'number', 'boolean'];
let notNeedHandleTypeArr = ['file', 'string', 'integer', 'long', 'double', 'object', 'number', 'boolean', 'ref'];
/**
* 参数解析
* @author 暮光：城中城
@@ -15,21 +15,23 @@ export default {
let requestParamList = [];
for (let i = 0; i < parameters.length; i++) {
let parameter = parameters[i];
let description = parameter.description || '';
let type = parameter.type;
let format = parameter.format;
let subType = undefined;
let children = undefined;
if (!type) {
if (parameter.schema && parameter.schema.type) {
type = parameter.schema.type;
}
}
let additional = undefined;
if (type === 'array') {
// 解析parameter.items.$ref 或 parameter.items.originalRef {$ref: "#/definitions/Model", originalRef: "Model"}
// 解析parameter.items.type {type: 'file'}
if (parameter.items && parameter.items.originalRef) {
children = this.getParamDefinitions(parameter.items.originalRef, definitionsDataMap, indexKey, {}, 0);
} else if (parameter.schema && parameter.schema.items && parameter.schema.items.originalRef) {
children = this.getParamDefinitions(parameter.schema.items.originalRef, definitionsDataMap, indexKey, {}, 0);
} else if (parameter.schema) {
if (parameter.schema.items && parameter.schema.items.originalRef) {
children = this.getParamDefinitions(parameter.schema.items.originalRef, definitionsDataMap, indexKey, {}, 0);
} else if (parameter.schema.type) {
subType = parameter.schema.type;
}
} else if (parameter.items && parameter.items.type) {
subType = parameter.items.type;
} else {
@@ -37,10 +39,43 @@ export default {
message.error('001-遇到未处理的类型，请联系开发人员修改：' + type);
}
} else if (!type) {
if (parameter.schema && parameter.schema.originalRef) {
// 解析parameter.schema {originalRef: "Model", $ref: "#/definitions/Model"}
type = parameter.schema.originalRef;
children = this.getParamDefinitions(type, definitionsDataMap, indexKey, {}, 0);
if (parameter.schema) {
if (parameter.schema.originalRef) {
// 解析parameter.schema {originalRef: "Model", $ref: "#/definitions/Model"}
type = parameter.schema.originalRef;
children = this.getParamDefinitions(type, definitionsDataMap, indexKey, {}, 0);
} else if (parameter.schema.type) {
type = parameter.schema.type;
if (parameter.schema.additionalProperties) {
additional = {};
children = this.getAdditionalProperties(parameter.schema.additionalProperties, additional, definitionsDataMap, indexKey, {}, 0);
format = additional.type;
} else if (parameter.schema.items) {
if (parameter.schema.items.originalRef) {
children = this.getParamDefinitions(parameter.schema.items.originalRef, definitionsDataMap, indexKey, {}, 0);
} else if (parameter.schema.items.type) {
subType = parameter.schema.items.type;
} else {
console.log('0014-遇到未处理的类型，请联系开发人员修改：' + type, parameter);
}
} else {
console.log('0011-遇到未处理的类型，请联系开发人员修改：' + type, parameter);
}
} else {
console.log('0013-遇到未处理的类型，请联系开发人员修改：' + type, parameter);
message.error('0013-遇到未处理的类型，请联系开发人员修改：' + type);
}
} else if (parameter.items && parameter.items.type) {
// 解析parameter.items {type: "object", $ref: "#/definitions/Model"}
type = parameter.items.type;
if (parameter.items.additionalProperties) {
additional = {};
children = this.getAdditionalProperties(parameter.items.additionalProperties, additional, definitionsDataMap, indexKey, {}, 0);
format = additional.type;
} else {
console.log('0012-遇到未处理的类型，请联系开发人员修改：' + type, parameter);
message.error('0012-遇到未处理的类型，请联系开发人员修改：' + type);
}
} else {
console.log('002-遇到未处理的类型，请联系开发人员修改：' + type, parameter);
message.error('002-遇到未处理的类型，请联系开发人员修改：' + type);
@@ -53,13 +88,22 @@ export default {
message.error('003-遇到未处理的类型，请联系开发人员修改：' + type);
}
}
if (parameter.enum && parameter.enum.length > 0) {
description = description || '枚举类型';
description += '，可选值：' + parameter.enum.join('、');
}
requestParamList.push({
type: type,
key: indexKey,
in: parameter.in,
name: parameter.name,
subType: subType,
required: parameter.required ? '是' : '否',
description: parameter.description,
format: format,
enum: parameter.enum,
collectionFormat: parameter.collectionFormat,// 枚举多选时=multi
description: description,
additional: additional,
children: children,
});
indexKey++;
@@ -90,29 +134,54 @@ export default {
},
getParamDefinitions(ref, definitionsDataMap, indexKey, parentRef, deep) {
let definition = definitionsDataMap[ref];
// 层级大于5层 或 父节点已经解析过此类型了 或者 没有类型定义
if (deep >= 5 || parentRef[ref] || !definition) {
// 层级大于5层 或者 没有类型定义
if (deep >= 10 || !definition) {
return undefined;
}
// 允许重复递归一次
parentRef[ref] = (parentRef[ref] || 0) + 1;
if (parentRef[ref] > 2) {
return undefined;
}
parentRef[ref] = 1;
let paramList = [];
let type = definition.type;
let properties = definition.properties;
let indexSub = 1;
if (type === 'object') {
let currentLevelTypes = {};
Object.keys(properties).forEach(key => {
let parameter = properties[key];
let type = parameter.type;
let format = parameter.format;
let description = parameter.description || '';
let subType = undefined;
let additional = undefined;
let enums = undefined;
let keySub = indexKey + '_' + indexSub;
let children = undefined;
// 把当前层级用过的类型清除，防止多个同类型在一层，后面的不能解析
Object.keys(currentLevelTypes).forEach(currentLevelType => {
parentRef[currentLevelType] = undefined;
});
if (type === 'array') {
// 解析parameter.items {originalRef: "Model", $ref: "#/definitions/Model"}
if (parameter.items && parameter.items.originalRef) {
subType = parameter.items.originalRef;
children = this.getParamDefinitions(parameter.items.originalRef, definitionsDataMap, keySub, parentRef, deep + 1);
} else if (parameter.items && parameter.items.type) {
subType = parameter.items.type;
} else {
console.log('004-遇到未处理的类型，请联系开发人员修改：' + type, parameter);
message.error('004-遇到未处理的类型，请联系开发人员修改：' + type);
}
} else if (type === 'object') {
if (parameter.additionalProperties) {
additional = {};
children = this.getAdditionalProperties(parameter.additionalProperties, additional, definitionsDataMap, keySub, parentRef, deep + 1);
format = additional.type;
} else {
console.log('0041-遇到未处理的类型，请联系开发人员修改：' + type, parameter);
}
} else if (!type) {
if (parameter.originalRef) {
type = parameter.originalRef;
@@ -129,18 +198,60 @@ export default {
message.error('006-遇到未处理的类型，请联系开发人员修改：' + type);
}
}
if (parameter.items && parameter.items.enum && parameter.items.enum.length > 0) {
enums = parameter.items.enum;
description = description || '枚举类型';
description += '，可选值：' + parameter.items.enum.join('、');
}
paramList.push({
type: type,
name: key,
key: keySub,
description: parameter.description,
subType: subType,
format: format,
description: description,
enum: enums,
additional: additional,
children: children,
});
indexSub++;
currentLevelTypes[type] = 1;
});
}
return paramList.length > 0 ? paramList : undefined;
},
getAdditionalProperties(additionalProperties, additional, definitionsDataMap, keySub, parentRef, deep) {
if (additionalProperties.originalRef) {
additional.type = additionalProperties.originalRef;
additional.children = this.getParamDefinitions(additionalProperties.originalRef, definitionsDataMap, keySub, parentRef, deep + 1);
return additional.additional;
} else if (additionalProperties.additionalProperties) {
additional.type = additionalProperties.type;
additional.additional = {};
return this.getAdditionalProperties(additionalProperties.additionalProperties, additional.additional, definitionsDataMap, keySub, parentRef, deep + 1);
} else if (additionalProperties.type === 'array') {
additional.type = additionalProperties.type;
if (additionalProperties.items && additionalProperties.items.originalRef) {
let children = this.getParamDefinitions(additionalProperties.items.originalRef, definitionsDataMap, keySub, parentRef, deep + 1);
additional.additional = {
type: additionalProperties.items.originalRef,
children: children
};
return children;
} else {
console.log('007-遇到未处理的类型，请联系开发人员修改：', additionalProperties);
message.error('007-遇到未处理的类型，请联系开发人员修改');
}
} else {
additional.type = additionalProperties.type;
if (notNeedHandleTypeArr.indexOf(additional.type) >= 0) {
// 无需特殊处理的类型
} else {
console.log('008-遇到未处理的类型，请联系开发人员修改：', additionalProperties);
message.error('008-遇到未处理的类型，请联系开发人员修改');
}
}
return undefined;
},
}