swagger已实现文档的参数和返回值查看
This commit is contained in:
暮光：城中城
@@ -1,146 +1,95 @@
|
||||
export function getDefinitions(definitions) {
|
||||
if (!definitions) {
|
||||
return {};
|
||||
}
|
||||
let swaggerDefinitions = {};
|
||||
Object.keys(definitions).forEach((key) => {
|
||||
swaggerDefinitions["#/definitions/" + key] = definitions[key];
|
||||
});
|
||||
return swaggerDefinitions;
|
||||
}
|
||||
|
||||
export function createTreeViewByTag(swagger, keywords) {
|
||||
let pathIndex = {}, treePathDataMap = {};
|
||||
let paths = swagger.paths;
|
||||
let domain = swagger.domainUrl;// 服务器代理会返回此属性
|
||||
let rewriteDomainUrl = swagger.rewriteDomainUrl;// 服务器代理会返回此属性
|
||||
if (!paths) {
|
||||
return;
|
||||
}
|
||||
if (!domain) {
|
||||
domain = "http://" + swagger.host + swagger.basePath;
|
||||
}
|
||||
if (domain.substring(domain.length - 1) === "/") {
|
||||
domain = domain.substring(0, domain.length - 1);
|
||||
}
|
||||
//console.log(paths);
|
||||
Object.keys(paths).forEach(key => {
|
||||
//console.log(key, paths[key]);
|
||||
setRequestMethodForTag(rewriteDomainUrl, domain, paths[key], pathIndex, key, "get", treePathDataMap);
|
||||
setRequestMethodForTag(rewriteDomainUrl, domain, paths[key], pathIndex, key, "head", treePathDataMap);
|
||||
setRequestMethodForTag(rewriteDomainUrl, domain, paths[key], pathIndex, key, "post", treePathDataMap);
|
||||
setRequestMethodForTag(rewriteDomainUrl, domain, paths[key], pathIndex, key, "put", treePathDataMap);
|
||||
setRequestMethodForTag(rewriteDomainUrl, domain, paths[key], pathIndex, key, "patch", treePathDataMap);
|
||||
setRequestMethodForTag(rewriteDomainUrl, domain, paths[key], pathIndex, key, "delete", treePathDataMap);
|
||||
setRequestMethodForTag(rewriteDomainUrl, domain, paths[key], pathIndex, key, "options", treePathDataMap);
|
||||
setRequestMethodForTag(rewriteDomainUrl, domain, paths[key], pathIndex, key, "trace", treePathDataMap);
|
||||
});
|
||||
// console.log(pathIndex);
|
||||
// console.log(treePathDataMap);
|
||||
// console.log(treeData);
|
||||
return {pathIndex: pathIndex, treePathDataMap: treePathDataMap};
|
||||
}
|
||||
const methodArray = ["get", "head", "post", "put", "patch", "delete", "options", "trace"];
|
||||
|
||||
/**
|
||||
* 设置对象的各种请求方式，存在则复制
|
||||
* @param source 资源，原始json的paths的指定对象
|
||||
* @param pathObj 当前的待赋值对象
|
||||
* @param url url绝对路径
|
||||
* @param method 请求方式，post、get...
|
||||
* @returns
|
||||
* 通过tag创建文档树
|
||||
* @param swagger 文档内容
|
||||
* @param keywords 搜索内容
|
||||
* @returns {{pathDataMap: {}, pathData: {}}}
|
||||
*/
|
||||
function setRequestMethodForTag(rewriteDomainUrl, domain, source, pathObj, url, method, treePathDataMap) {
|
||||
if (!source[method] || !source[method].tags) {
|
||||
return;
|
||||
export function createTreeViewByTag(swagger, keywords) {
|
||||
let pathData = {}, pathDataMap = {};
|
||||
let swaggerPaths = swagger.paths;
|
||||
if (!swaggerPaths) {
|
||||
return {pathDataMap, pathData};
|
||||
}
|
||||
source[method].tags.forEach(function(val, index) {
|
||||
let tempObj = pathObj[val];
|
||||
if(!tempObj) {
|
||||
tempObj = pathObj[val] = {};
|
||||
//console.log(swaggerPaths);
|
||||
Object.keys(swaggerPaths).forEach(url => {
|
||||
//console.log(key, swaggerPaths[key]);
|
||||
let pathMethods = swaggerPaths[url];
|
||||
for (let method of methodArray) {
|
||||
if (!pathMethods[method] || !pathMethods[method].tags) {
|
||||
continue;
|
||||
}
|
||||
pathMethods[method].tags.forEach(tag => {
|
||||
let pathTag = pathData[tag];
|
||||
if (!pathTag) {
|
||||
pathTag = pathData[tag] = {};
|
||||
}
|
||||
let pathTagUrl = pathTag[url];
|
||||
if (!pathTagUrl) {
|
||||
pathTagUrl = pathTag[url] = {};
|
||||
}
|
||||
let tempPath = url + "." + method;
|
||||
pathTagUrl[method] = pathMethods[method];
|
||||
pathTagUrl[method].path = tempPath;
|
||||
pathTagUrl[method].url = url;
|
||||
pathTagUrl[method].method = method;
|
||||
// url对应文档的映射
|
||||
pathDataMap[tempPath] = pathMethods[method];
|
||||
});
|
||||
}
|
||||
let tempUrlObj = tempObj[url];
|
||||
if(!tempUrlObj) {
|
||||
tempUrlObj = tempObj[url] = {};
|
||||
}
|
||||
let tempPath = url + "." + method;
|
||||
tempUrlObj[method] = source[method];
|
||||
tempUrlObj[method].path = tempPath;
|
||||
tempUrlObj[method].url = url;
|
||||
tempUrlObj[method].method = method;
|
||||
tempUrlObj[method].domain = domain;
|
||||
tempUrlObj[method].rewriteDomainUrl = rewriteDomainUrl;
|
||||
treePathDataMap[tempPath] = source[method];
|
||||
});
|
||||
return {pathData, pathDataMap};
|
||||
}
|
||||
|
||||
export function getTreeDataForTag(swagger, pathData, metaInfo) {
|
||||
return [
|
||||
{
|
||||
key: 'main',
|
||||
title: swagger.title || 'Swagger接口文档',
|
||||
key: '0-0',
|
||||
children: getTreeHtmlForTag(pathData, 0, metaInfo)
|
||||
children: getTreeHtmlForTag(swagger.tags, pathData, metaInfo)
|
||||
}
|
||||
];
|
||||
}
|
||||
|
||||
function getTreeHtmlForTag(pathData, treeId, metaInfo) {
|
||||
function getTreeHtmlForTag(swaggerTags, pathData, metaInfo) {
|
||||
let treeData = [];
|
||||
let indexNow = 1;
|
||||
// get, head, post, put, patch, delete, options, trace
|
||||
let actionArrays = ["get", "head", "post", "put", "patch", "delete", "options", "trace"];
|
||||
Object.keys(pathData).forEach(key => {
|
||||
let tempNode = pathData[key];
|
||||
let tempTreeId = treeId + "_" + indexNow;
|
||||
// 只有一个子元素，而且有method元素，说明是只有一个节点
|
||||
let nodeSub = getObjectFirstAttributeIfOnly(tempNode);
|
||||
if (nodeSub && nodeSub.method) {
|
||||
nodeSub.treeId = tempTreeId;
|
||||
let title = nodeSub.summary || nodeSub.path;
|
||||
treeData.push({
|
||||
title: title,
|
||||
key: tempTreeId,
|
||||
isLeaf: true,
|
||||
method: nodeSub.method,
|
||||
query: {
|
||||
...metaInfo,
|
||||
path: nodeSub.url,
|
||||
method: nodeSub.method,
|
||||
}
|
||||
});
|
||||
} else if (actionArrays.indexOf(key) >= 0) {
|
||||
tempNode.treeId = tempTreeId;
|
||||
let title = tempNode.summary || tempNode.path;
|
||||
treeData.push({
|
||||
title: title,
|
||||
key: tempTreeId,
|
||||
isLeaf: true,
|
||||
method: tempNode.method,
|
||||
query: {
|
||||
...metaInfo,
|
||||
path: tempNode.url,
|
||||
method: tempNode.method,
|
||||
}
|
||||
});
|
||||
} else {
|
||||
treeData.push({title: key, key: key, children: getTreeHtmlForTag(tempNode, tempTreeId, metaInfo)});
|
||||
let indexTag = 1;
|
||||
// 遍历分组
|
||||
swaggerTags.forEach(tag => {
|
||||
let indexUrl = 1;
|
||||
let urlTree = [];
|
||||
let pathTagNode = pathData[tag.name];
|
||||
if (!pathTagNode) {
|
||||
return;
|
||||
}
|
||||
indexNow++;
|
||||
// 遍历路劲
|
||||
Object.keys(pathTagNode).forEach(url => {
|
||||
let indexMethod = 1;
|
||||
let pathUrlNode = pathTagNode[url];
|
||||
// 遍历方法
|
||||
Object.keys(pathUrlNode).forEach(method => {
|
||||
let tempTreeId = indexTag + "_" + indexUrl + "_" + indexMethod;
|
||||
let methodNode = pathUrlNode[method];
|
||||
methodNode.treeId = tempTreeId;
|
||||
let title = methodNode.summary || methodNode.path;
|
||||
urlTree.push({
|
||||
title: title,
|
||||
key: tempTreeId,
|
||||
isLeaf: true,
|
||||
method: methodNode.method,
|
||||
query: {
|
||||
...metaInfo,
|
||||
path: methodNode.url,
|
||||
method: methodNode.method,
|
||||
}
|
||||
});
|
||||
indexMethod++;
|
||||
});
|
||||
indexUrl++;
|
||||
});
|
||||
treeData.push({title: tag.name, key: indexTag, children: urlTree});
|
||||
indexTag++;
|
||||
});
|
||||
return treeData;
|
||||
}
|
||||
|
||||
/**
|
||||
* 如果对象只有一个属性则返回第一个属性，否则返回null
|
||||
* @param data
|
||||
* @returns
|
||||
*/
|
||||
function getObjectFirstAttributeIfOnly(data) {
|
||||
let len = 0, value = "";
|
||||
for (let key in data) {
|
||||
if (++len > 1) {
|
||||
return undefined;
|
||||
}
|
||||
value = data[key];
|
||||
}
|
||||
return value;
|
||||
}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import {createStore} from 'vuex'
|
||||
import {getDefinitions, createTreeViewByTag} from './SwaggerDocUtil'
|
||||
import {createTreeViewByTag} from './SwaggerDocUtil'
|
||||
|
||||
export default createStore({
|
||||
state() {
|
||||
@@ -9,7 +9,7 @@ export default createStore({
|
||||
pageTabNameMap: {},
|
||||
swaggerDoc: {},
|
||||
swaggerDefinitions: {},
|
||||
swaggerTreePathMap: [],
|
||||
swaggerTreePathMap: {},
|
||||
}
|
||||
},
|
||||
mutations: {
|
||||
@@ -21,7 +21,7 @@ export default createStore({
|
||||
},
|
||||
setSwaggerDoc(state, swaggerDoc) {
|
||||
state.swaggerDoc = swaggerDoc;
|
||||
state.swaggerDefinitions = getDefinitions(swaggerDoc.definitions);
|
||||
state.swaggerDefinitions = swaggerDoc.definitions || {};
|
||||
},
|
||||
setSwaggerTreePathMap(state, swaggerTreePathMap) {
|
||||
state.swaggerTreePathMap = swaggerTreePathMap;
|
||||
|
||||
Reference in New Issue
Block a user