1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308let hooks, pluginModule;
/**
* type component 组件
* listener 监听函数
* mulit 是否绑定多个监听函数
*/
hooks = {
/**
* 第三方登录 //可参考 yapi-plugin-qsso 插件
*/
third_login: {
type: 'component',
mulit: false,
listener: null
},
/**
* 导入数据
* @param Object importDataModule
*
* @info
* 可参考 vendors/exts/yapi-plugin-import-swagger插件
* importDataModule = {};
*/
import_data: {
type: 'listener',
mulit: true,
listener: []
},
/**
* 导出数据
* @param Object exportDataModule
* @param projectId
* @info
* exportDataModule = {};
* exportDataModule.pdf = {
* name: 'Pdf',
* route: '/api/plugin/export/pdf',
* desc: '导出项目接口文档为 pdf 文件'
* }
*/
export_data: {
type: 'listener',
mulit: true,
listener: []
},
/**
* 接口页面 tab 钩子
* @param InterfaceTabs
*
* @info
* 可参考 vendors/exts/yapi-plugin-advanced-mock
* let InterfaceTabs = {
view: {
component: View,
name: '预览'
},
edit: {
component: Edit,
name: '编辑'
},
run: {
component: Run,
name: '运行'
}
}
*/
interface_tab: {
type: 'listener',
mulit: true,
listener: []
},
/**
* 在运行页面或单个测试也里每次发送请求前调用
* 可以用插件针对某个接口的请求头或者数据进行修改或者记录
*/
before_request: {
type: 'listener',
mulit: true,
listener: []
},
/**
* 在运行页面或单个测试也里每次发送完成后调用
* 返回值为响应原始值 +
* {
* type: 'inter' | 'case',
* projectId: string,
* interfaceId: string
* }
*/
after_request: {
type: 'listener',
mulit: true,
listener: []
},
/**
* 在测试集里运行每次发送请求前调用
*/
before_col_request: {
type: 'listener',
mulit: true,
listener: []
},
/**
* 在测试集里运行每次发送请求后调用
* 返回值为响应原始值 +
* {
* type: 'col',
* caseId: string,
* projectId: string,
* interfaceId: string
* }
*/
after_col_request: {
type: 'listener',
mulit: true,
listener: []
},
/**
* header下拉菜单 menu 钩子
* @param HeaderMenu
*
* @info
* 可参考 vendors/exts/yapi-plugin-statistics
* let HeaderMenu = {
user: {
path: '/user/profile',
name: '个人中心',
icon: 'user',
adminFlag: false
},
star: {
path: '/follow',
name: '我的关注',
icon: 'star-o',
adminFlag: false
},
solution: {
path: '/user/list',
name: '用户管理',
icon: 'solution',
adminFlag: true
},
logout: {
path: '',
name: '退出',
icon: 'logout',
adminFlag: false
}
};
*/
header_menu: {
type: 'listener',
mulit: true,
listener: []
},
/**
* Route路由列表钩子
* @param AppRoute
*
* @info
* 可参考 vendors/exts/yapi-plugin-statistics
* 添加位置在Application.js 中
* let AppRoute = {
home: {
path: '/',
component: Home
},
group: {
path: '/group',
component: Group
},
project: {
path: '/project/:id',
component: Project
},
user: {
path: '/user',
component: User
},
follow: {
path: '/follow',
component: Follows
},
addProject: {
path: '/add-project',
component: AddProject
},
login: {
path: '/login',
component: Login
}
};
};
*/
app_route: {
type: 'listener',
mulit: true,
listener: []
},
/*
* 添加 reducer
* @param Object reducerModules
*
* @info
* importDataModule = {};
*/
add_reducer: {
type: 'listener',
mulit: true,
listener: []
},
/*
* 添加 subnav 钩子
* @param Object reducerModules
*
* let routers = {
interface: { name: '接口', path: "/project/:id/interface/:action", component:Interface },
activity: { name: '动态', path: "/project/:id/activity", component: Activity},
data: { name: '数据管理', path: "/project/:id/data", component: ProjectData},
members: { name: '成员管理', path: "/project/:id/members" , component: ProjectMember},
setting: { name: '设置', path: "/project/:id/setting" , component: Setting}
}
*/
sub_nav: {
type: 'listener',
mulit: true,
listener: []
},
/*
* 添加项目设置 nav
* @param Object routers
*
* let routers = {
interface: { name: 'xxx', component: Xxx },
}
*/
sub_setting_nav:{
type: 'listener',
mulit: true,
listener: []
}
};
function bindHook(name, listener) {
if (!name) {
throw new Error('缺少hookname');
}
if (name in hooks === false) {
throw new Error('不存在的hookname');
}
if (hooks[name].mulit === true) {
hooks[name].listener.push(listener);
} else {
hooks[name].listener = listener;
}
}
function emitHook(name, ...args) {
if (!hooks[name]) {
throw new Error('不存在的hook name');
}
let hook = hooks[name];
if (hook.mulit === true && hook.type === 'listener') {
if (Array.isArray(hook.listener)) {
let promiseAll = [];
hook.listener.forEach(item => {
if (typeof item === 'function') {
promiseAll.push(Promise.resolve(item.call(pluginModule, ...args)));
}
});
return Promise.all(promiseAll);
}
} else if (hook.mulit === false && hook.type === 'listener') {
if (typeof hook.listener === 'function') {
return Promise.resolve(hook.listener.call(pluginModule, ...args));
}
} else if (hook.type === 'component') {
return hook.listener;
}
}
pluginModule = {
hooks: hooks,
bindHook: bindHook,
emitHook: emitHook
};
let pluginModuleList;
try {
pluginModuleList = require('./plugin-module.js');
} catch (err) {
pluginModuleList = {};
}
Object.keys(pluginModuleList).forEach(plugin => {
if (!pluginModuleList[plugin]) return null;
if (pluginModuleList[plugin] && typeof pluginModuleList[plugin].module === 'function') {
pluginModuleList[plugin].module.call(pluginModule, pluginModuleList[plugin].options);
}
});
module.exports = pluginModule;