-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathswagger.yaml
More file actions
492 lines (492 loc) · 12.6 KB
/
Copy pathswagger.yaml
File metadata and controls
492 lines (492 loc) · 12.6 KB
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
openapi: 3.0.1
info:
title: kantab API Documentation
description: 基于icebob / kantab项目的看板应用,moleculer微服务架构,整合iview-admin后台管理,swagger接口文档、swagger-stats监控面板、moleculer_lab监控、REST API、GraphQL endpoint.
version: 1.0.0
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
security:
- bearerAuth: []
paths:
/api/v1/accounts/register:
post:
tags:
- Accounts
summary: 创建一个用户
description: 创建一个用户
requestBody:
content:
application/json:
schema:
required:
- fullName
- username
- password
- email
type: object
properties:
fullName:
type: string
description: 全名
username:
type: string
description: 登录用户名
password:
type: string
description: 登录密码
email:
type: string
description: 邮箱
avatar:
type: string
description: 头像
required: false
responses:
'200':
description: 请求成功
content: {}
'400':
description: 参数错误
content: {}
x-codegen-request-body-name: params
/api/v1/accounts/login:
post:
tags:
- Accounts
summary: 用户登录
description: 用户 登录
requestBody:
content:
application/json:
schema:
required:
- email
- password
type: object
properties:
email:
type: string
description: 登录email或用户名
password:
type: string
description: 登录密码
required: false
responses:
'200':
description: 请求成功
content: {}
'422':
description: 缺失参数
content: {}
x-codegen-request-body-name: params
/api/v1/accounts/userlist:
get:
tags:
- Accounts
summary: 用户列表
description: 后台账户列表,手动实现v1.accounts.list相同功能
responses:
'200':
description: 请求成功
content: {}
'401':
description: 无操作权限
content: {}
/admins/register:
post:
tags:
- Admin
summary: 创建一个管理员
description: 创建一个管理员
requestBody:
content:
application/json:
schema:
required:
- username
- password
- mobile
- roles
- avatar
type: object
properties:
username:
type: string
description: 后台登录用户名
default: guest
password:
type: string
description: 后台登录密码
default: 123456
mobile:
type: string
description: 手机号
default: null
roles:
type: array
items:
type: string
description: 角色权限
default:
- guest
avatar:
type: string
description: 头像
default: null
required: false
responses:
'200':
description: 请求成功
content: {}
'400':
description: 参数错误
content: {}
x-codegen-request-body-name: params
/admins/auth:
post:
tags:
- Admin
summary: 后台管理员登录
description: 后台管理员登录
requestBody:
content:
application/json:
schema:
required:
- username
- password
type: object
properties:
username:
type: string
description: 后台登录用户名
password:
type: string
description: 后台登录密码
required: false
responses:
'200':
description: 请求成功
content: {}
'422':
description: 缺失参数
content: {}
x-codegen-request-body-name: params
/admins/disable:
get:
tags:
- Admin
summary: 禁用一个后台账户
description: 禁用一个后台账户
parameters:
- name: id
in: query
description: 账号ID
schema:
type: string
responses:
'200':
description: 请求成功
content: {}
'400':
description: 账户已是启用状态
content: {}
/admins/list:
get:
tags:
- Admin
summary: DbService内置actions 测试
description: 混合选项actionVisibility为public的情况下,DbService混进来的actions及同名自定义action例如 list find update等都将无法被api网关对外发布
responses:
'200':
description: 请求成功
content: {}
'404':
description: 404 Service 'v1.admins.list' is not found
content: {}
/admins/adminlist:
get:
tags:
- Admin
summary: 后台账户列表
description: 后台账户列表,手动实现v1.admins.list相同功能
responses:
'200':
description: 请求成功
content: {}
'401':
description: 无操作权限
content: {}
/admins/enable:
get:
tags:
- Admin
summary: 启用一个后台账户
description: 启用一个后台账户
parameters:
- name: id
in: query
description: 账号ID
schema:
type: string
responses:
'200':
description: 请求成功
content: {}
'400':
description: 账户已是启用状态
content: {}
/admins/getAdminInfo:
get:
tags:
- Admin
summary: 获取管理员账号信息
description: 获取管理员账号信息
parameters:
- name: id
in: query
description: 账号ID
schema:
type: string
responses:
'200':
description: 请求成功
content: {}
'422':
description: 缺少参数
content: {}
/admins/me:
get:
tags:
- Admin
summary: 获取当前账号信息
description: 获取当前账号信息
responses:
'200':
description: 请求成功
content: {}
'422':
description: 缺失参数
content: {}
put:
tags:
- Admin
summary: 更新当前账号信息
description: 更新当前账号信息
requestBody:
content:
application/json:
schema:
type: object
properties:
admin:
type: object
properties:
avatar:
type: string
description: 头像地址
roles:
type: array
items:
type: string
description: 账号权限
default: guest
required: false
responses:
'200':
description: 请求成功
content: {}
'422':
description: 缺失参数
content: {}
x-codegen-request-body-name: params
/api/v1/boards:
post:
tags:
- Boards
summary: 创建看板
description: 创建看板
requestBody:
content:
application/json:
schema:
required:
- title
- description
- public
type: object
properties:
title:
type: string
description: 看板名称
description:
type: string
description: 看板描述
public:
type: boolean
description: 是否公开
default: false
required: false
responses:
'200':
description: 请求成功
content: {}
'400':
description: 参数错误
content: {}
x-codegen-request-body-name: params
get:
tags:
- Boards
summary: 看板列表
description: 看板列表
responses:
'200':
description: 请求成功
content: {}
'401':
description: 无操作权限
content: {}
/api/v1/boards/{id}:
get:
tags:
- Boards
summary: 根据ID查看某个面板
description: 根据ID查看某个board,注意defaultScopes带来的影响,看板的成员才可以查看
parameters:
- name: id
in: path
description: 账号ID
schema:
type: string
responses:
'200':
description: 请求成功
content: {}
'401':
description: 无操作权限
content: {}
/greeter/hello:
get:
tags:
- Greeter
summary: say hello
description: say hello
responses:
'200':
description: welcome result
content: {}
'422':
description: Missing parameters
content: {}
x-codegen-request-body-name: params
/greeter/welcome:
post:
tags:
- Greeter
summary: Welcome a username
description: Welcome a username
requestBody:
content:
application/json:
schema:
required:
- name
type: object
properties:
name:
type: string
description: Name to be used
default: John
required: false
responses:
'200':
description: welcome result
content: {}
'422':
description: Missing parameters
content: {}
x-codegen-request-body-name: params
/api/v1/boards/{board}/lists:
post:
tags:
- Lists
summary: 创建条目
description: 创建条目
parameters:
- name: board
in: path
description: 看板ID
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- title
- description
type: object
properties:
title:
type: string
description: 条目名称
description:
type: string
description: 条目描述
required: false
responses:
'200':
description: 请求成功
content: {}
'400':
description: 参数错误
content: {}
x-codegen-request-body-name: params
get:
tags:
- Lists
summary: 看板下所有条目
description: 看板下所有条目
parameters:
- name: board
in: path
description: 看板ID
schema:
type: string
responses:
'200':
description: 请求成功
content: {}
'401':
description: 无操作权限
content: {}
/api/v1/boards/{board}/lists/{id}:
get:
tags:
- Lists
summary: 根据看板ID、条目ID查看某个条目
description: 根据看板ID、条目ID查看某个条目
parameters:
- name: board
in: path
description: 看板ID
schema:
type: string
- name: id
in: path
description: 条目ID
schema:
type: string
responses:
'200':
description: 请求成功
content: {}
'401':
description: 无操作权限
content: {}
tags: []