yapi/server/controllers/interfaceCol.js

588 lines
21 KiB
JavaScript
Raw Normal View History

const interfaceColModel = require('../models/interfaceCol.js');
const interfaceCaseModel = require('../models/interfaceCase.js');
const interfaceModel = require('../models/interface.js');
const projectModel = require('../models/project.js');
const baseController = require('./base.js');
const yapi = require('../yapi.js');
class interfaceColController extends baseController{
constructor(ctx) {
super(ctx);
2017-08-09 16:16:35 +08:00
this.colModel = yapi.getInst(interfaceColModel);
this.caseModel = yapi.getInst(interfaceCaseModel);
this.interfaceModel = yapi.getInst(interfaceModel);
2017-08-28 20:39:32 +08:00
this.projectModel = yapi.getInst(projectModel);
}
2017-08-09 16:16:35 +08:00
/**
* 获取所有接口集
* @interface /col/list
* @method GET
* @category col
* @foldnumber 10
* @param {String} project_id email名称不能为空
2017-08-15 12:08:59 +08:00
* @returns {Object}
* @example
2017-08-09 16:16:35 +08:00
*/
2017-08-08 19:47:36 +08:00
async list(ctx){
2017-08-29 11:25:50 +08:00
try {
2017-08-08 19:47:36 +08:00
let id = ctx.query.project_id;
2017-09-14 18:14:48 +08:00
let project = await this.projectModel.getBaseInfo(id);
if (project.project_type === 'private') {
2017-09-21 16:46:14 +08:00
if (await this.checkAuth(project._id, 'project', 'view') !== true) {
2017-09-14 18:14:48 +08:00
return ctx.body = yapi.commons.resReturn(null, 406, '没有权限');
}
}
2017-08-15 12:08:59 +08:00
let result = await this.colModel.list(id);
for(let i=0; i< result.length;i++){
result[i] = result[i].toObject();
result[i].caseList = await this.caseModel.list(result[i]._id)
}
2017-08-08 19:47:36 +08:00
ctx.body = yapi.commons.resReturn(result);
} catch (e) {
ctx.body = yapi.commons.resReturn(null, 402, e.message);
}
}
2017-08-09 16:16:35 +08:00
/**
* 增加接口集
* @interface /col/add_col
* @method POST
* @category col
* @foldnumber 10
* @param {Number} project_id
* @param {String} name
* @param {String} desc
2017-08-15 12:08:59 +08:00
* @returns {Object}
* @example
2017-08-09 16:16:35 +08:00
*/
async addCol(ctx){
try{
let params = ctx.request.body;
params = yapi.commons.handleParams(params, {
name: 'string',
project_id: 'number',
desc: 'string'
});
2017-08-15 12:08:59 +08:00
2017-08-09 16:16:35 +08:00
if (!params.project_id) {
2017-08-15 12:08:59 +08:00
return ctx.body = yapi.commons.resReturn(null, 400, '项目id不能为空');
2017-08-09 16:16:35 +08:00
}
if(!params.name){
2017-08-15 12:08:59 +08:00
return ctx.body = yapi.commons.resReturn(null, 400, '名称不能为空');
2017-08-09 16:16:35 +08:00
}
2017-08-15 12:08:59 +08:00
2017-08-24 14:17:19 +08:00
let auth = await this.checkAuth(params.project_id, 'project', 'edit')
if (!auth) {
return ctx.body = yapi.commons.resReturn(null, 400, '没有权限');
}
2017-08-09 16:16:35 +08:00
let result = await this.colModel.save({
name: params.name,
project_id: params.project_id,
desc: params.desc,
uid: this.getUid(),
add_time: yapi.commons.time(),
up_time: yapi.commons.time()
2017-08-24 16:40:33 +08:00
});
let username = this.getUsername();
yapi.commons.saveLog({
2017-10-13 17:25:23 +08:00
content: `<a href="/user/profile/${this.getUid()}">${username}</a> 添加了接口集 <a href="/project/${params.project_id}/interface/col/${result._id}">${params.name}</a>`,
2017-08-24 16:40:33 +08:00
type: 'project',
uid: this.getUid(),
username: username,
typeid: params.project_id
});
// this.projectModel.up(params.project_id,{up_time: new Date().getTime()}).then();
2017-08-09 16:16:35 +08:00
ctx.body = yapi.commons.resReturn(result);
}catch(e){
ctx.body = yapi.commons.resReturn(null, 402, e.message);
}
}
/**
* 获取一个接口集下的所有的接口用例
* @interface /col/case_list
* @method GET
* @category col
* @foldnumber 10
* @param {String} col_id 接口集id
2017-08-15 12:08:59 +08:00
* @returns {Object}
* @example
2017-08-09 16:16:35 +08:00
*/
async getCaseList(ctx){
try {
let id = ctx.query.col_id;
2017-09-14 18:14:48 +08:00
if(!id || id == 0){
return ctx.body = yapi.commons.resReturn(null, 407, 'col_id不能为空')
}
2017-09-20 20:21:58 +08:00
let resultList = await this.caseModel.list(id, 'all');
2017-09-14 18:14:48 +08:00
let colData = await this.colModel.get(id);
let project = await this.projectModel.getBaseInfo(colData.project_id);
if (project.project_type === 'private') {
2017-09-21 16:46:14 +08:00
if (await this.checkAuth(project._id, 'project', 'view') !== true) {
2017-09-14 18:14:48 +08:00
return ctx.body = yapi.commons.resReturn(null, 406, '没有权限');
}
}
2017-09-20 20:21:58 +08:00
for(let index=0; index< resultList.length; index++){
let result = resultList[index].toObject();
let data = await this.interfaceModel.get(result.interface_id);
if(!data){
await this.caseModel.del(result._id);
continue;
2017-09-14 18:14:48 +08:00
}
2017-09-20 20:21:58 +08:00
let projectData = await this.projectModel.getBaseInfo(data.project_id);
result.path = projectData.basepath + data.path;
result.method = data.method;
result.req_body_type = data.req_body_type;
result.req_headers = data.req_headers;
result.res_body = data.res_body;
2017-09-21 11:24:24 +08:00
result.res_body_type = data.res_body_type;
result.req_body_form = this.handleParamsValue(data.req_body_form, result.req_body_form)
2017-09-20 20:21:58 +08:00
result.req_query = this.handleParamsValue(data.req_query, result.req_query)
result.req_params = this.handleParamsValue(data.req_params, result.req_params)
resultList[index] = result;
}
2017-09-20 20:21:58 +08:00
ctx.body = yapi.commons.resReturn(resultList);
2017-08-09 16:16:35 +08:00
} catch (e) {
ctx.body = yapi.commons.resReturn(null, 402, e.message);
}
}
/**
* 增加一个接口用例
* @interface /col/add_case
* @method POST
* @category col
* @foldnumber 10
* @param {String} casename
* @param {Number} col_id
* @param {Number} project_id
* @param {String} domain
* @param {String} path
* @param {String} method
* @param {Object} req_query
* @param {Object} req_headers
* @param {String} req_body_type
2017-08-15 12:08:59 +08:00
* @param {Array} req_body_form
2017-08-09 16:16:35 +08:00
* @param {String} req_body_other
2017-08-15 12:08:59 +08:00
* @returns {Object}
* @example
2017-08-09 16:16:35 +08:00
*/
async addCase(ctx){
try{
let params = ctx.request.body;
params = yapi.commons.handleParams(params, {
casename: 'string',
project_id: 'number',
col_id: 'number',
interface_id: 'number',
2017-08-29 10:01:27 +08:00
case_env: 'string'
2017-08-09 16:16:35 +08:00
});
2017-08-15 12:08:59 +08:00
2017-08-24 14:17:19 +08:00
2017-08-09 16:16:35 +08:00
if (!params.project_id) {
2017-08-15 12:08:59 +08:00
return ctx.body = yapi.commons.resReturn(null, 400, '项目id不能为空');
2017-08-09 16:16:35 +08:00
}
2017-08-24 14:17:19 +08:00
if(!params.interface_id){
return ctx.body = yapi.commons.resReturn(null, 400, '接口id不能为空');
}
let auth = await this.checkAuth(params.project_id, 'project', 'edit');
2017-08-24 14:17:19 +08:00
if (!auth) {
return ctx.body = yapi.commons.resReturn(null, 400, '没有权限');
}
2017-08-09 16:16:35 +08:00
if (!params.col_id) {
2017-08-15 12:08:59 +08:00
return ctx.body = yapi.commons.resReturn(null, 400, '接口集id不能为空');
2017-08-09 16:16:35 +08:00
}
2017-08-15 12:08:59 +08:00
2017-08-09 16:16:35 +08:00
if(!params.casename){
2017-08-15 12:08:59 +08:00
return ctx.body = yapi.commons.resReturn(null, 400, '用例名称不能为空');
2017-08-09 16:16:35 +08:00
}
params.uid = this.getUid();
params.index = 0;
params.add_time = yapi.commons.time();
params.up_time = yapi.commons.time();
let result = await this.caseModel.save(params);
2017-08-24 16:40:33 +08:00
let username = this.getUsername();
2017-08-24 19:27:48 +08:00
this.colModel.get(params.col_id).then((col)=>{
yapi.commons.saveLog({
2017-10-13 17:25:23 +08:00
content: `<a href="/user/profile/${this.getUid()}">${username}</a> 在接口集 <a href="/project/${params.project_id}/interface/col/${params.col_id}">${col.name}</a> 下添加了接口用例 <a href="/project/${params.project_id}/interface/case/${result._id}">${params.casename}</a>`,
2017-08-24 19:27:48 +08:00
type: 'project',
uid: this.getUid(),
username: username,
typeid: params.project_id
});
2017-08-24 16:40:33 +08:00
});
this.projectModel.up(params.project_id,{up_time: new Date().getTime()}).then();
2017-08-29 11:25:50 +08:00
2017-08-09 16:16:35 +08:00
ctx.body = yapi.commons.resReturn(result);
2017-08-24 10:33:17 +08:00
}catch(e){
ctx.body = yapi.commons.resReturn(null, 402, e.message);
}
}
2017-09-29 14:58:07 +08:00
async addCaseList(ctx){
try{
let params = ctx.request.body;
params = yapi.commons.handleParams(params, {
project_id: 'number',
col_id: 'number'
});
if(!params.interface_list || !Array.isArray(params.interface_list)){
return ctx.body = yapi.commons.resReturn(null, 400, 'interface_list 参数有误');
}
if (!params.project_id) {
return ctx.body = yapi.commons.resReturn(null, 400, '项目id不能为空');
}
let auth = await this.checkAuth(params.project_id, 'project', 'edit');
if (!auth) {
return ctx.body = yapi.commons.resReturn(null, 400, '没有权限');
}
if (!params.col_id) {
return ctx.body = yapi.commons.resReturn(null, 400, '接口集id不能为空');
}
let data = {
uid: this.getUid(),
index: 0,
add_time: yapi.commons.time(),
up_time: yapi.commons.time(),
project_id: params.project_id,
col_id: params.col_id
}
for(let i=0; i<params.interface_list.length; i++){
let interfaceData = await this.interfaceModel.getBaseinfo(params.interface_list[i]);
data.interface_id = params.interface_list[i];
data.casename = interfaceData.title;
await this.caseModel.save(data);
let username = this.getUsername();
this.colModel.get(params.col_id).then((col)=>{
yapi.commons.saveLog({
2017-10-13 17:25:23 +08:00
content: `<a href="/user/profile/${this.getUid()}">${username}</a> 在接口集 <a href="/project/${params.project_id}/interface/col/${params.col_id}">${col.name}</a> 下导入了接口 <a href="/project/${params.project_id}/interface/case/${data.interface_id}">${data.casename}</a>`,
2017-09-29 14:58:07 +08:00
type: 'project',
uid: this.getUid(),
username: username,
typeid: params.project_id
});
});
}
this.projectModel.up(params.project_id,{up_time: new Date().getTime()}).then();
ctx.body = yapi.commons.resReturn('ok');
}catch(e){
ctx.body = yapi.commons.resReturn(null, 402, e.message);
}
}
2017-08-24 10:33:17 +08:00
/**
2017-08-24 16:40:33 +08:00
* 更新一个接口用例
2017-08-24 10:33:17 +08:00
* @interface /col/up_case
* @method POST
* @category col
* @foldnumber 10
* @param {number} id
* @param {String} casename
* @param {String} domain
* @param {String} path
* @param {String} method
* @param {Object} req_query
* @param {Object} req_headers
* @param {String} req_body_type
* @param {Array} req_body_form
* @param {String} req_body_other
* @returns {Object}
* @example
*/
async upCase(ctx){
try{
let params = ctx.request.body;
params = yapi.commons.handleParams(params, {
id: 'number',
casename: 'string'
2017-08-24 10:33:17 +08:00
});
if (!params.id) {
return ctx.body = yapi.commons.resReturn(null, 400, '用例id不能为空');
}
2017-10-12 20:45:34 +08:00
// if(!params.casename){
// return ctx.body = yapi.commons.resReturn(null, 400, '用例名称不能为空');
// }
2017-08-24 10:33:17 +08:00
2017-08-24 21:07:49 +08:00
let caseData = await this.caseModel.get(params.id);
let auth = await this.checkAuth(caseData.project_id, 'project', 'edit');
2017-08-24 14:17:19 +08:00
if (!auth) {
return ctx.body = yapi.commons.resReturn(null, 400, '没有权限');
}
2017-08-24 10:33:17 +08:00
params.uid = this.getUid();
delete params.interface_id;
delete params.project_id;
2017-10-12 20:45:34 +08:00
// delete params.col_id;
2017-08-24 11:11:38 +08:00
let result = await this.caseModel.up(params.id, params);
2017-08-24 16:40:33 +08:00
let username = this.getUsername();
2017-08-24 19:27:48 +08:00
this.colModel.get(caseData.col_id).then((col)=>{
yapi.commons.saveLog({
2017-10-13 17:25:23 +08:00
content:`<a href="/user/profile/${this.getUid()}">${username}</a> 在接口集 <a href="/project/${caseData.project_id}/interface/col/${caseData.col_id}">${col.name}</a> 更新了接口用例 <a href="/project/${caseData.project_id}/interface/case/${params.id}">${params.casename || caseData.casename}</a>`,
2017-08-24 19:27:48 +08:00
type: 'project',
uid: this.getUid(),
username: username,
typeid: caseData.project_id
});
2017-08-24 16:40:33 +08:00
});
2017-08-29 11:25:50 +08:00
this.projectModel.up(caseData.project_id,{up_time: new Date().getTime()}).then();
2017-08-24 10:33:17 +08:00
ctx.body = yapi.commons.resReturn(result);
2017-08-09 16:16:35 +08:00
}catch(e){
ctx.body = yapi.commons.resReturn(null, 402, e.message);
}
}
/**
* 获取一个接口用例详情
* @interface /col/case
* @method GET
* @category col
* @foldnumber 10
* @param {String} caseid
2017-08-15 12:08:59 +08:00
* @returns {Object}
* @example
2017-08-09 16:16:35 +08:00
*/
async getCase(ctx){
try{
let id = ctx.query.caseid;
let result = await this.caseModel.get(id);
if(!result){
return ctx.body = yapi.commons.resReturn(null, 400, '不存在的case');
}
result = result.toObject();
2017-09-20 20:21:58 +08:00
let data = await this.interfaceModel.get(result.interface_id);
if(!data){
return ctx.body = yapi.commons.resReturn(null, 400, '找不到对应的接口,请联系管理员')
}
data = data.toObject();
let projectData = await this.projectModel.getBaseInfo(data.project_id);
2017-08-28 20:39:32 +08:00
result.path = projectData.basepath + data.path;
result.method = data.method;
result.req_body_type = data.req_body_type;
result.req_headers = data.req_headers;
2017-08-31 15:18:37 +08:00
result.res_body = data.res_body;
2017-09-21 11:24:24 +08:00
result.res_body_type = data.res_body_type;
result.req_body_form = this.handleParamsValue(data.req_body_form, result.req_body_form)
result.req_query = this.handleParamsValue(data.req_query, result.req_query)
result.req_params = this.handleParamsValue(data.req_params, result.req_params)
2017-08-31 15:18:37 +08:00
2017-08-09 16:16:35 +08:00
ctx.body = yapi.commons.resReturn(result);
}catch(e){
ctx.body = yapi.commons.resReturn(null, 400, e.message)
}
}
handleParamsValue(params, val){
let value = {};
2017-09-21 11:24:24 +08:00
try{
params = params.toObject();
}catch(e){ }
if(params.length === 0 || val.length === 0){
return params;
}
val.forEach((item, index)=>{
value[item.name] = item;
})
params.forEach((item, index)=>{
if(!value[item.name] || typeof value[item.name] !== 'object') return null;
2017-09-21 11:24:24 +08:00
params[index].value = value[item.name].value;
})
return params;
}
2017-08-09 16:16:35 +08:00
/**
* 更新一个接口集name或描述
* @interface /col/up_col
2017-08-09 20:11:39 +08:00
* @method POST
2017-08-09 16:16:35 +08:00
* @category col
* @foldnumber 10
* @param {String} name
* @param {String} desc
2017-08-15 12:08:59 +08:00
* @returns {Object}
* @example
2017-08-09 16:16:35 +08:00
*/
async upCol(ctx){
try{
let params = ctx.request.body;
2017-08-24 14:17:19 +08:00
let id = params.col_id;
let colData = await this.colModel.get(id);
let auth = await this.checkAuth(colData.project_id, 'project', 'edit')
if (!auth) {
return ctx.body = yapi.commons.resReturn(null, 400, '没有权限');
}
2017-08-22 16:50:15 +08:00
let result = await this.colModel.up(params.col_id, {
name: params.name,
desc: params.desc,
2017-08-09 16:16:35 +08:00
up_time: yapi.commons.time()
2017-08-24 16:40:33 +08:00
});
let username = this.getUsername();
yapi.commons.saveLog({
2017-10-13 17:25:23 +08:00
contnet: `<a href="/user/profile/${this.getUid()}">${username}</a> 更新了接口集 <a href="/project/${colData.project_id}/interface/col/${params.col_id}">${params.name}</a> 的信息`,
2017-08-24 16:40:33 +08:00
type: 'project',
uid: this.getUid(),
username: username,
typeid: colData.project_id
});
2017-08-09 16:16:35 +08:00
ctx.body = yapi.commons.resReturn(result)
}catch(e){
ctx.body = yapi.commons.resReturn(null, 400, e.message)
}
}
2017-08-09 20:11:39 +08:00
/**
* 更新多个接口case index
* @interface /col/up_col_index
* @method POST
* @category col
* @foldnumber 10
* @param {Array} [id, index]
2017-08-15 12:08:59 +08:00
* @returns {Object}
* @example
2017-08-09 20:11:39 +08:00
*/
async upCaseIndex(ctx){
try{
let params = ctx.request.body;
if(!params || !Array.isArray(params)){
ctx.body = yapi.commons.resReturn(null, 400, "请求参数必须是数组")
}
params.forEach((item) => {
2017-09-19 17:20:37 +08:00
if(item.id){
2017-08-09 20:11:39 +08:00
this.caseModel.upCaseIndex(item.id, item.index).then((res) => {}, (err) => {
yapi.commons.log(err.message, 'error')
})
}
2017-08-15 12:08:59 +08:00
2017-08-24 19:27:48 +08:00
});
2017-08-29 11:25:50 +08:00
return ctx.body = yapi.commons.resReturn('成功!')
2017-08-09 20:11:39 +08:00
}catch(e){
ctx.body = yapi.commons.resReturn(null, 400, e.message)
}
}
2017-08-09 16:16:35 +08:00
/**
* 删除一个接口集
2017-08-09 20:11:39 +08:00
* @interface /col/del_col
2017-08-09 16:16:35 +08:00
* @method GET
* @category col
* @foldnumber 10
2017-08-15 12:08:59 +08:00
* @param {String}
* @returns {Object}
* @example
2017-08-09 16:16:35 +08:00
*/
async delCol(ctx){
2017-08-09 20:11:39 +08:00
try{
2017-08-22 18:05:20 +08:00
let id = ctx.query.col_id;
2017-08-09 20:11:39 +08:00
let colData = await this.colModel.get(id);
if(!colData){
ctx.body = yapi.commons.resReturn(null, 400, "不存在的id")
}
2017-08-09 16:16:35 +08:00
2017-08-09 20:11:39 +08:00
if(colData.uid !== this.getUid()){
let auth = await this.checkAuth(colData.project_id, 'project', 'danger')
if(!auth){
return ctx.body = yapi.commons.resReturn(null, 400, '没有权限');
}
}
2017-08-22 18:05:20 +08:00
let result = await this.colModel.del(id);
2017-08-24 19:27:48 +08:00
await this.caseModel.delByCol(id);
let username = this.getUsername();
yapi.commons.saveLog({
2017-10-13 17:25:23 +08:00
content: `<a href="/user/profile/${this.getUid()}">${username}</a> 删除了接口集 <a href="/project/${colData.project_id}/interface/col/${id}">${colData.name}</a> 及其下面的接口`,
2017-08-24 19:27:48 +08:00
type: 'project',
uid: this.getUid(),
username: username,
typeid: colData.project_id
});
2017-08-09 20:11:39 +08:00
return ctx.body = yapi.commons.resReturn(result);
}catch(e){
yapi.commons.resReturn(null, 400, e.message)
}
2017-08-09 16:16:35 +08:00
}
/**
2017-08-15 12:08:59 +08:00
*
* @param {*} ctx
2017-08-09 16:16:35 +08:00
*/
async delCase(ctx){
2017-08-09 20:11:39 +08:00
try{
2017-08-22 18:05:20 +08:00
let caseid = ctx.query.caseid;
2017-08-09 20:11:39 +08:00
let caseData = await this.caseModel.get(caseid);
if(!caseData){
ctx.body = yapi.commons.resReturn(null, 400, "不存在的caseid")
}
if(caseData.uid !== this.getUid()){
let auth = await this.checkAuth(caseData.project_id, 'project', 'danger')
if(!auth){
return ctx.body = yapi.commons.resReturn(null, 400, '没有权限');
}
}
2017-08-09 16:16:35 +08:00
2017-08-09 20:11:39 +08:00
let result = await this.caseModel.del(caseid);
2017-08-24 19:27:48 +08:00
let username = this.getUsername();
this.colModel.get(caseData.col_id).then((col)=>{
yapi.commons.saveLog({
2017-10-13 17:25:23 +08:00
content: `<a href="/user/profile/${this.getUid()}">${username}</a> 删除了接口集 <a href="/project/${caseData.project_id}/interface/col/${caseData.col_id}">${col.name}</a> 下的接口 <a href="/project/${caseData.project_id}/interface/case/${caseid}">${caseData.casename}</a>`,
2017-08-24 19:27:48 +08:00
type: 'project',
uid: this.getUid(),
username: username,
typeid: caseData.project_id
});
});
2017-08-29 11:25:50 +08:00
this.projectModel.up(caseData.project_id,{up_time: new Date().getTime()}).then();
2017-08-09 20:11:39 +08:00
return ctx.body = yapi.commons.resReturn(result);
}catch(e){
yapi.commons.resReturn(null, 400, e.message)
}
2017-08-09 16:16:35 +08:00
}
}
2017-08-15 12:08:59 +08:00
module.exports = interfaceColController