blob: 56b364d897b1e3a1355c0df7362b4941dc8414c3 [file] [log] [blame]
刘洪青0fb603f2018-08-09 10:54:08 +08001openapi: 3.0.0
2info:
3 version: 1.0.0
4 title: Sample User
5servers:
6 - url: 'http://localhost:10010/api/v1'
7paths:
刘洪青1d10ee82018-08-16 10:08:36 +08008 /admin/users:
刘洪青0fb603f2018-08-09 10:54:08 +08009 get:
10 summary: 查询用户
11 operationId: admin-users-list
12 tags:
13 - Api1AdminUserController
14 parameters:
15 - name: pageIndex
16 in: query
17 description: 分页-页码
18 required: true
19 schema:
20 type: integer
21 format: int32
22 default: 0
23 - name: pageSize
24 in: query
25 description: 分页-每页记录数
26 required: true
27 schema:
28 type: integer
29 format: int32
30 default: 20
31 - name: 'mapBean[username]'
32 in: query
33 description: 查询条件-用户名
34 required: false
35 schema:
36 type: string
37 - name: 'mapBean[name]'
38 in: query
39 description: 查询条件-姓名
40 required: false
41 schema:
42 type: string
43 - name: 'mapBean[status]'
44 in: query
45 description: 查询条件-状态(1 启用,0 停用)
46 required: false
47 schema:
48 type: string
49 responses:
50 '200':
51 description: 用户列表
52 content:
53 application/json:
54 schema:
刘洪青1d10ee82018-08-16 10:08:36 +080055 $ref: '#/components/schemas/UserPagerResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +080056 default:
57 description: unexpected error
58 content:
59 application/json:
60 schema:
61 $ref: '#/components/schemas/Error'
62 post:
63 summary: 创建用户
64 operationId: admin-users-create
65 tags:
66 - Api1AdminUserController
67 requestBody:
68 content:
69 application/json:
70 schema:
71 $ref: '#/components/schemas/User'
72 examples:
73 test1:
刘洪青1d10ee82018-08-16 10:08:36 +080074 value:
75 companyId: '1'
76 deleted: false
77 addAccount: admin
78 username: test1
79 password: test1
80 enabled: true
81 accountNonExpired: true
82 accountNonLocked: true
83 credentialsNonExpired: true
84 name: 测试1
85 status: '1'
刘洪青0fb603f2018-08-09 10:54:08 +080086 responses:
87 '200':
88 description: 创建成功
89 content:
90 application/json:
91 schema:
刘洪青1d10ee82018-08-16 10:08:36 +080092 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +080093 examples:
94 success:
95 value:
96 success: info.create.success
97 default:
98 description: unexpected error
99 content:
100 application/json:
101 schema:
102 $ref: '#/components/schemas/Error'
103 put:
104 summary: 修改用户
105 operationId: admin-users-update
106 tags:
107 - Api1AdminUserController
108 requestBody:
109 content:
110 application/json:
111 schema:
112 $ref: '#/components/schemas/User'
113 examples:
114 test1:
刘洪青1d10ee82018-08-16 10:08:36 +0800115 value:
116 id: '1'
117 status: '0'
刘洪青0fb603f2018-08-09 10:54:08 +0800118 responses:
119 '200':
120 description: 修改成功
121 content:
122 application/json:
123 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800124 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800125 examples:
126 success:
127 value:
128 success: info.update.success
129 default:
130 description: unexpected error
131 content:
132 application/json:
133 schema:
134 $ref: '#/components/schemas/Error'
135 '/admin/users/{id}':
136 get:
137 summary: 根据ID获取用户
138 operationId: admin-users-get
139 tags:
140 - Api1AdminUserController
141 parameters:
142 - name: id
143 in: path
144 required: true
145 description: 用户ID
146 schema:
147 type: string
148 responses:
149 '200':
150 description: Expected response to a valid request
151 content:
152 application/json:
153 schema:
154 $ref: '#/components/schemas/User'
155 default:
156 description: unexpected error
157 content:
158 application/json:
159 schema:
160 $ref: '#/components/schemas/Error'
161 delete:
162 summary: 根据ID删除用户
163 operationId: admin-users-delete
164 tags:
165 - Api1AdminUserController
166 parameters:
167 - name: id
168 in: path
169 required: true
170 description: 用户ID
171 schema:
172 type: string
173 responses:
174 '200':
175 description: Expected response to a valid request
176 content:
177 application/json:
178 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800179 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800180 examples:
181 success:
182 value:
183 success: info.delete.success
184 default:
185 description: unexpected error
186 content:
187 application/json:
188 schema:
189 $ref: '#/components/schemas/Error'
190 '/admin/users/{id}/groups':
191 get:
192 summary: 根据ID获取用户的关联用户组
193 operationId: admin-users-userGroups
194 tags:
195 - Api1AdminUserController
196 parameters:
197 - name: id
198 in: path
199 required: true
200 description: 用户ID
201 schema:
202 type: string
203 - name: pageIndex
204 in: query
205 description: 分页-页码
206 required: true
207 schema:
208 type: integer
209 format: int32
210 default: 0
211 - name: pageSize
212 in: query
213 description: 分页-每页记录数
214 required: true
215 schema:
216 type: integer
217 format: int32
218 default: 20
219 - name: 'mapBean[groupCode]'
220 in: query
221 description: 查询条件-用户组代码
222 required: false
223 schema:
224 type: string
225 - name: 'mapBean[groupName]'
226 in: query
227 description: 查询条件-用户组名称
228 required: false
229 schema:
230 type: string
231 - name: 'mapBean[groupStatus]'
232 in: query
233 description: 查询条件-用户组状态(1 启用,0 停用)
234 required: false
235 schema:
236 type: string
237 responses:
238 '200':
239 description: 用户的关联用户组列表
240 content:
241 application/json:
242 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800243 $ref: '#/components/schemas/UserGroupPagerResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800244 default:
245 description: unexpected error
246 content:
247 application/json:
248 schema:
249 $ref: '#/components/schemas/Error'
250 post:
251 summary: 关联用户的用户组
252 operationId: admin-users-relateGroups
253 tags:
254 - Api1AdminUserController
255 parameters:
256 - name: id
257 in: path
258 required: true
259 description: 用户ID
260 schema:
261 type: string
262 requestBody:
263 content:
264 application/json:
265 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800266 $ref: '#/components/schemas/UserGroups'
刘洪青0fb603f2018-08-09 10:54:08 +0800267 responses:
268 '200':
269 description: 设置成功
270 content:
271 application/json:
272 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800273 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800274 examples:
275 success:
刘洪青1d10ee82018-08-16 10:08:36 +0800276 value:
277 success: info.set.success
刘洪青0fb603f2018-08-09 10:54:08 +0800278 default:
279 description: unexpected error
280 content:
281 application/json:
282 schema:
283 $ref: '#/components/schemas/Error'
284 '/admin/users/{id}/roles':
285 get:
286 summary: 根据ID获取用户的关联角色
287 operationId: admin-users-userRoles
288 tags:
289 - Api1AdminUserController
290 parameters:
291 - name: id
292 in: path
293 required: true
294 description: 用户ID
295 schema:
296 type: string
297 - name: pageIndex
298 in: query
299 description: 分页-页码
300 required: true
301 schema:
302 type: integer
303 format: int32
304 default: 0
305 - name: pageSize
306 in: query
307 description: 分页-每页记录数
308 required: true
309 schema:
310 type: integer
311 format: int32
312 default: 20
313 - name: 'mapBean[roleCode]'
314 in: query
315 description: 查询条件-角色代码
316 required: false
317 schema:
318 type: string
319 - name: 'mapBean[roleName]'
320 in: query
321 description: 查询条件-角色名称
322 required: false
323 schema:
324 type: string
325 - name: 'mapBean[roleStatus]'
326 in: query
327 description: 查询条件-角色状态(1 启用,0 停用)
328 required: false
329 schema:
330 type: string
331 responses:
332 '200':
333 description: 用户的关联角色列表
334 content:
335 application/json:
336 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800337 $ref: '#/components/schemas/UserRolePagerResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800338 default:
339 description: unexpected error
340 content:
341 application/json:
342 schema:
343 $ref: '#/components/schemas/Error'
344 post:
345 summary: 关联用户的角色
346 operationId: admin-users-relateRoles
347 tags:
348 - Api1AdminUserController
349 parameters:
350 - name: id
351 in: path
352 required: true
353 description: 用户ID
354 schema:
355 type: string
356 requestBody:
357 content:
358 application/json:
359 schema:
360 $ref: '#/components/schemas/UserRoles'
361 responses:
362 '200':
363 description: 设置成功
364 content:
365 application/json:
366 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800367 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800368 examples:
369 success:
刘洪青1d10ee82018-08-16 10:08:36 +0800370 value:
371 success: info.set.success
刘洪青0fb603f2018-08-09 10:54:08 +0800372 default:
373 description: unexpected error
374 content:
375 application/json:
376 schema:
377 $ref: '#/components/schemas/Error'
刘洪青1d10ee82018-08-16 10:08:36 +0800378 /admin/groups:
刘洪青0fb603f2018-08-09 10:54:08 +0800379 get:
380 summary: 查询用户组
381 operationId: admin-groups-list
382 tags:
383 - Api1AdminGroupController
384 parameters:
385 - name: pageIndex
386 in: query
387 description: 分页-页码
388 required: true
389 schema:
390 type: integer
391 format: int32
392 default: 0
393 - name: pageSize
394 in: query
395 description: 分页-每页记录数
396 required: true
397 schema:
398 type: integer
399 format: int32
400 default: 20
401 - name: 'mapBean[code]'
402 in: query
403 description: 查询条件-代码
404 required: false
405 schema:
406 type: string
407 - name: 'mapBean[name]'
408 in: query
409 description: 查询条件-名称
410 required: false
411 schema:
412 type: string
413 - name: 'mapBean[status]'
414 in: query
415 description: 查询条件-状态(1 启用,0 停用)
416 required: false
417 schema:
418 type: string
419 responses:
420 '200':
421 description: 用户组列表
422 content:
423 application/json:
424 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800425 $ref: '#/components/schemas/GroupPagerResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800426 default:
427 description: unexpected error
428 content:
429 application/json:
430 schema:
431 $ref: '#/components/schemas/Error'
432 post:
433 summary: 创建用户组
434 operationId: admin-groups-create
435 tags:
436 - Api1AdminGroupController
437 requestBody:
438 content:
439 application/json:
440 schema:
441 $ref: '#/components/schemas/Group'
442 examples:
443 test1:
刘洪青1d10ee82018-08-16 10:08:36 +0800444 value:
445 companyId: '1'
446 deleted: false
447 addAccount: admin
448 code: group1
449 name: 测试组1
450 memo: ''
451 status: '1'
刘洪青0fb603f2018-08-09 10:54:08 +0800452 responses:
453 '200':
454 description: 创建成功
455 content:
456 application/json:
457 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800458 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800459 examples:
460 success:
461 value:
462 success: info.create.success
463 default:
464 description: unexpected error
465 content:
466 application/json:
467 schema:
468 $ref: '#/components/schemas/Error'
469 put:
470 summary: 修改用户组
471 operationId: admin-groups-update
472 tags:
473 - Api1AdminGroupController
474 requestBody:
475 content:
476 application/json:
477 schema:
478 $ref: '#/components/schemas/Group'
479 examples:
480 test1:
刘洪青1d10ee82018-08-16 10:08:36 +0800481 value:
482 id: '1'
483 status: '0'
刘洪青0fb603f2018-08-09 10:54:08 +0800484 responses:
485 '200':
486 description: 修改成功
487 content:
488 application/json:
489 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800490 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800491 examples:
492 success:
493 value:
494 success: info.update.success
495 default:
496 description: unexpected error
497 content:
498 application/json:
499 schema:
500 $ref: '#/components/schemas/Error'
501 '/admin/groups/{id}':
502 get:
503 summary: 根据ID获取用户组
504 operationId: admin-groups-get
505 tags:
506 - Api1AdminGroupController
507 parameters:
508 - name: id
509 in: path
510 required: true
511 description: 用户组ID
512 schema:
513 type: string
514 responses:
515 '200':
516 description: Expected response to a valid request
517 content:
518 application/json:
519 schema:
520 $ref: '#/components/schemas/Group'
521 default:
522 description: unexpected error
523 content:
524 application/json:
525 schema:
526 $ref: '#/components/schemas/Error'
527 delete:
528 summary: 根据ID删除用户组
529 operationId: admin-groups-delete
530 tags:
531 - Api1AdminGroupController
532 parameters:
533 - name: id
534 in: path
535 required: true
536 description: 用户组ID
537 schema:
538 type: string
539 responses:
540 '200':
541 description: Expected response to a valid request
542 content:
543 application/json:
544 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800545 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800546 examples:
547 success:
548 value:
549 success: info.delete.success
550 default:
551 description: unexpected error
552 content:
553 application/json:
554 schema:
555 $ref: '#/components/schemas/Error'
556 '/admin/groups/{id}/users':
557 get:
558 summary: 根据ID获取用户组的关联用户
559 operationId: admin-groups-groupUsers
560 tags:
561 - Api1AdminGroupController
562 parameters:
563 - name: id
564 in: path
565 required: true
566 description: 用户ID
567 schema:
568 type: string
569 - name: pageIndex
570 in: query
571 description: 分页-页码
572 required: true
573 schema:
574 type: integer
575 format: int32
576 default: 0
577 - name: pageSize
578 in: query
579 description: 分页-每页记录数
580 required: true
581 schema:
582 type: integer
583 format: int32
584 default: 20
585 - name: 'mapBean[userUsername]'
586 in: query
587 description: 查询条件-用户名
588 required: false
589 schema:
590 type: string
591 - name: 'mapBean[userName]'
592 in: query
593 description: 查询条件-用户姓名
594 required: false
595 schema:
596 type: string
597 - name: 'mapBean[userStatus]'
598 in: query
599 description: 查询条件-用户状态(1 启用,0 停用)
600 required: false
601 schema:
602 type: string
603 responses:
604 '200':
605 description: 用户组的关联用户列表
606 content:
607 application/json:
608 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800609 $ref: '#/components/schemas/UserGroupPagerResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800610 default:
611 description: unexpected error
612 content:
613 application/json:
614 schema:
615 $ref: '#/components/schemas/Error'
616 post:
617 summary: 关联用户组的用户
618 operationId: admin-groups-relateUsers
619 tags:
620 - Api1AdminGroupController
621 parameters:
622 - name: id
623 in: path
624 required: true
625 description: 用户ID
626 schema:
627 type: string
628 requestBody:
629 content:
630 application/json:
631 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800632 $ref: '#/components/schemas/UserGroups'
刘洪青0fb603f2018-08-09 10:54:08 +0800633 responses:
634 '200':
635 description: 设置成功
636 content:
637 application/json:
638 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800639 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800640 examples:
641 success:
刘洪青1d10ee82018-08-16 10:08:36 +0800642 value:
643 success: info.set.success
刘洪青0fb603f2018-08-09 10:54:08 +0800644 default:
645 description: unexpected error
646 content:
647 application/json:
648 schema:
649 $ref: '#/components/schemas/Error'
650 '/admin/groups/{id}/roles':
651 get:
652 summary: 根据ID获取用户组的关联角色
653 operationId: admin-groups-groupRoles
654 tags:
655 - Api1AdminGroupController
656 parameters:
657 - name: id
658 in: path
659 required: true
660 description: 用户ID
661 schema:
662 type: string
663 - name: pageIndex
664 in: query
665 description: 分页-页码
666 required: true
667 schema:
668 type: integer
669 format: int32
670 default: 0
671 - name: pageSize
672 in: query
673 description: 分页-每页记录数
674 required: true
675 schema:
676 type: integer
677 format: int32
678 default: 20
679 - name: 'mapBean[roleCode]'
680 in: query
681 description: 查询条件-角色代码
682 required: false
683 schema:
684 type: string
685 - name: 'mapBean[roleName]'
686 in: query
687 description: 查询条件-角色名称
688 required: false
689 schema:
690 type: string
691 - name: 'mapBean[roleStatus]'
692 in: query
693 description: 查询条件-角色状态(1 启用,0 停用)
694 required: false
695 schema:
696 type: string
697 responses:
698 '200':
699 description: 用户组的关联角色列表
700 content:
701 application/json:
702 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800703 $ref: '#/components/schemas/GroupRolePagerResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800704 default:
705 description: unexpected error
706 content:
707 application/json:
708 schema:
709 $ref: '#/components/schemas/Error'
710 post:
711 summary: 关联用户组的角色
712 operationId: admin-groups-relateRoles
713 tags:
714 - Api1AdminGroupController
715 parameters:
716 - name: id
717 in: path
718 required: true
719 description: 用户ID
720 schema:
721 type: string
722 requestBody:
723 content:
724 application/json:
725 schema:
726 $ref: '#/components/schemas/GroupRoles'
727 responses:
728 '200':
729 description: 设置成功
730 content:
731 application/json:
732 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800733 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800734 examples:
735 success:
刘洪青1d10ee82018-08-16 10:08:36 +0800736 value:
737 success: info.set.success
刘洪青0fb603f2018-08-09 10:54:08 +0800738 default:
739 description: unexpected error
740 content:
741 application/json:
742 schema:
743 $ref: '#/components/schemas/Error'
刘洪青1d10ee82018-08-16 10:08:36 +0800744 /admin/roles:
刘洪青0fb603f2018-08-09 10:54:08 +0800745 get:
746 summary: 查询角色
747 operationId: admin-roles-list
748 tags:
749 - Api1AdminRoleController
750 parameters:
751 - name: pageIndex
752 in: query
753 description: 分页-页码
754 required: true
755 schema:
756 type: integer
757 format: int32
758 default: 0
759 - name: pageSize
760 in: query
761 description: 分页-每页记录数
762 required: true
763 schema:
764 type: integer
765 format: int32
766 default: 20
767 - name: 'mapBean[code]'
768 in: query
769 description: 查询条件-代码
770 required: false
771 schema:
772 type: string
773 - name: 'mapBean[name]'
774 in: query
775 description: 查询条件-名称
776 required: false
777 schema:
778 type: string
779 - name: 'mapBean[status]'
780 in: query
781 description: 查询条件-状态(1 启用,0 停用)
782 required: false
783 schema:
784 type: string
785 responses:
786 '200':
787 description: 角色列表
788 content:
789 application/json:
790 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800791 $ref: '#/components/schemas/RolePagerResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800792 default:
793 description: unexpected error
794 content:
795 application/json:
796 schema:
797 $ref: '#/components/schemas/Error'
798 post:
799 summary: 创建角色
800 operationId: admin-roles-create
801 tags:
802 - Api1AdminRoleController
803 requestBody:
804 content:
805 application/json:
806 schema:
807 $ref: '#/components/schemas/Role'
808 examples:
809 test1:
刘洪青1d10ee82018-08-16 10:08:36 +0800810 value:
811 companyId: '1'
812 deleted: false
813 addAccount: admin
814 code: role1
815 name: 测试角色1
816 memo: ''
817 status: '1'
刘洪青0fb603f2018-08-09 10:54:08 +0800818 responses:
819 '200':
820 description: 创建成功
821 content:
822 application/json:
823 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800824 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800825 examples:
826 success:
827 value:
828 success: info.create.success
829 default:
830 description: unexpected error
831 content:
832 application/json:
833 schema:
834 $ref: '#/components/schemas/Error'
835 put:
836 summary: 修改角色
837 operationId: admin-roles-update
838 tags:
839 - Api1AdminRoleController
840 requestBody:
841 content:
842 application/json:
843 schema:
844 $ref: '#/components/schemas/Role'
845 examples:
846 test1:
刘洪青1d10ee82018-08-16 10:08:36 +0800847 value:
848 id: '1'
849 status: '0'
刘洪青0fb603f2018-08-09 10:54:08 +0800850 responses:
851 '200':
852 description: 修改成功
853 content:
854 application/json:
855 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800856 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800857 examples:
858 success:
859 value:
860 success: info.update.success
861 default:
862 description: unexpected error
863 content:
864 application/json:
865 schema:
866 $ref: '#/components/schemas/Error'
867 '/admin/roles/{id}':
868 get:
869 summary: 根据ID获取角色
870 operationId: admin-roles-get
871 tags:
872 - Api1AdminRoleController
873 parameters:
874 - name: id
875 in: path
876 required: true
877 description: 角色ID
878 schema:
879 type: string
880 responses:
881 '200':
882 description: Expected response to a valid request
883 content:
884 application/json:
885 schema:
886 $ref: '#/components/schemas/Role'
887 default:
888 description: unexpected error
889 content:
890 application/json:
891 schema:
892 $ref: '#/components/schemas/Error'
893 delete:
894 summary: 根据ID删除角色
895 operationId: admin-roles-delete
896 tags:
897 - Api1AdminRoleController
898 parameters:
899 - name: id
900 in: path
901 required: true
902 description: 角色ID
903 schema:
904 type: string
905 responses:
906 '200':
907 description: Expected response to a valid request
908 content:
909 application/json:
910 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800911 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800912 examples:
913 success:
914 value:
915 success: info.delete.success
916 default:
917 description: unexpected error
918 content:
919 application/json:
920 schema:
921 $ref: '#/components/schemas/Error'
922 '/admin/roles/{id}/users':
923 get:
924 summary: 根据ID获取角色的关联用户
925 operationId: admin-roles-roleUsers
926 tags:
927 - Api1AdminRoleController
928 parameters:
929 - name: id
930 in: path
931 required: true
932 description: 角色ID
933 schema:
934 type: string
935 - name: pageIndex
936 in: query
937 description: 分页-页码
938 required: true
939 schema:
940 type: integer
941 format: int32
942 default: 0
943 - name: pageSize
944 in: query
945 description: 分页-每页记录数
946 required: true
947 schema:
948 type: integer
949 format: int32
950 default: 20
951 - name: 'mapBean[userUsername]'
952 in: query
953 description: 查询条件-用户名
954 required: false
955 schema:
956 type: string
957 - name: 'mapBean[userName]'
958 in: query
959 description: 查询条件-用户姓名
960 required: false
961 schema:
962 type: string
963 - name: 'mapBean[userStatus]'
964 in: query
965 description: 查询条件-用户状态(1 启用,0 停用)
966 required: false
967 schema:
968 type: string
969 responses:
970 '200':
971 description: 角色的关联用户列表
972 content:
973 application/json:
974 schema:
刘洪青1d10ee82018-08-16 10:08:36 +0800975 $ref: '#/components/schemas/UserRolePagerResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +0800976 default:
977 description: unexpected error
978 content:
979 application/json:
980 schema:
981 $ref: '#/components/schemas/Error'
982 post:
983 summary: 关联角色的用户
984 operationId: admin-roles-relateUsers
985 tags:
986 - Api1AdminRoleController
987 parameters:
988 - name: id
989 in: path
990 required: true
991 description: 角色ID
992 schema:
993 type: string
994 requestBody:
995 content:
996 application/json:
997 schema:
998 $ref: '#/components/schemas/UserRoles'
999 responses:
1000 '200':
1001 description: 设置成功
1002 content:
1003 application/json:
1004 schema:
刘洪青1d10ee82018-08-16 10:08:36 +08001005 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +08001006 examples:
1007 success:
刘洪青1d10ee82018-08-16 10:08:36 +08001008 value:
1009 success: info.set.success
刘洪青0fb603f2018-08-09 10:54:08 +08001010 default:
1011 description: unexpected error
1012 content:
1013 application/json:
1014 schema:
1015 $ref: '#/components/schemas/Error'
1016 '/admin/roles/{id}/groups':
1017 get:
1018 summary: 根据ID获取角色的关联用户组
1019 operationId: admin-roles-roleGroups
1020 tags:
1021 - Api1AdminRoleController
1022 parameters:
1023 - name: id
1024 in: path
1025 required: true
1026 description: 角色ID
1027 schema:
1028 type: string
1029 - name: pageIndex
1030 in: query
1031 description: 分页-页码
1032 required: true
1033 schema:
1034 type: integer
1035 format: int32
1036 default: 0
1037 - name: pageSize
1038 in: query
1039 description: 分页-每页记录数
1040 required: true
1041 schema:
1042 type: integer
1043 format: int32
1044 default: 20
1045 - name: 'mapBean[groupCode]'
1046 in: query
1047 description: 查询条件-用户组代码
1048 required: false
1049 schema:
1050 type: string
1051 - name: 'mapBean[groupName]'
1052 in: query
1053 description: 查询条件-用户组名称
1054 required: false
1055 schema:
1056 type: string
1057 - name: 'mapBean[groupStatus]'
1058 in: query
1059 description: 查询条件-用户组状态(1 启用,0 停用)
1060 required: false
1061 schema:
1062 type: string
1063 responses:
1064 '200':
1065 description: 角色的关联用户组列表
1066 content:
1067 application/json:
1068 schema:
刘洪青1d10ee82018-08-16 10:08:36 +08001069 $ref: '#/components/schemas/GroupRolePagerResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +08001070 default:
1071 description: unexpected error
1072 content:
1073 application/json:
1074 schema:
1075 $ref: '#/components/schemas/Error'
1076 post:
1077 summary: 关联角色的用户组
1078 operationId: admin-roles-relateGroups
1079 tags:
1080 - Api1AdminRoleController
1081 parameters:
1082 - name: id
1083 in: path
1084 required: true
1085 description: 角色ID
1086 schema:
1087 type: string
1088 requestBody:
1089 content:
1090 application/json:
1091 schema:
1092 $ref: '#/components/schemas/GroupRoles'
1093 responses:
1094 '200':
1095 description: 设置成功
1096 content:
1097 application/json:
1098 schema:
刘洪青1d10ee82018-08-16 10:08:36 +08001099 $ref: '#/components/schemas/SuccessResponseModel'
刘洪青0fb603f2018-08-09 10:54:08 +08001100 examples:
1101 success:
刘洪青1d10ee82018-08-16 10:08:36 +08001102 value:
1103 success: info.set.success
刘洪青0fb603f2018-08-09 10:54:08 +08001104 default:
1105 description: unexpected error
1106 content:
1107 application/json:
1108 schema:
1109 $ref: '#/components/schemas/Error'
1110components:
1111 schemas:
刘洪青6fd78db2018-08-16 12:32:34 +08001112 PagerRequestModel:
刘洪青0fb603f2018-08-09 10:54:08 +08001113 properties:
刘洪青6fd78db2018-08-16 12:32:34 +08001114 pageIndex:
刘洪青0fb603f2018-08-09 10:54:08 +08001115 type: integer
1116 format: int32
刘洪青6fd78db2018-08-16 12:32:34 +08001117 pageSize:
1118 type: integer
1119 format: int32
刘洪青0fb603f2018-08-09 10:54:08 +08001120 PagerResponseModel:
1121 properties:
1122 pageIndex:
1123 type: integer
1124 format: int32
1125 pageSize:
1126 type: integer
1127 format: int32
1128 currentItemCount:
1129 type: integer
1130 format: int32
1131 pageCount:
1132 type: integer
1133 format: int32
1134 recordCount:
1135 type: integer
1136 format: int64
刘洪青6fd78db2018-08-16 12:32:34 +08001137 SuccessResponseModel:
1138 properties:
1139 success:
1140 type: string
1141 Error:
1142 required:
1143 - code
1144 - message
1145 properties:
1146 code:
1147 type: integer
1148 format: int32
1149 message:
1150 type: string
刘洪青0fb603f2018-08-09 10:54:08 +08001151 BaseDomain:
1152 properties:
1153 id:
1154 description: ID
1155 type: string
1156 companyId:
1157 description: 'Company ID, 固定 1'
1158 type: string
1159 deleted:
1160 description: 是否删除
1161 type: boolean
1162 default: false
1163 addAccount:
1164 description: 创建人
1165 type: string
1166 addTime:
1167 description: 创建时间
1168 type: string
1169 format: date
1170 editAccount:
1171 description: 修改人
1172 type: string
1173 editTime:
1174 description: 修改时间
1175 type: string
1176 format: date
1177 deleteAccount:
1178 description: 删除人
1179 type: string
1180 deleteTime:
1181 description: 删除时间
1182 type: string
1183 format: date
1184 User:
1185 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001186 - $ref: '#/components/schemas/BaseDomain'
1187 - type: object
1188 properties:
1189 username:
1190 description: 用户名
1191 type: string
1192 password:
1193 description: 密码
1194 type: string
1195 format: password
1196 enabled:
1197 description: 是否可用,1 可用,0 不可用,默认:1
1198 type: boolean
1199 default: true
1200 accountNonExpired:
1201 description: 账号未过期,1 未过期,0 过期,默认:1
1202 type: boolean
1203 default: true
1204 accountNonLocked:
1205 description: 账号未锁定,1 未锁定,0 锁定,默认:1
1206 type: boolean
1207 default: true
1208 credentialsNonExpired:
1209 description: 密码未过期,1 未过期,0 过期,默认:1
1210 type: boolean
1211 default: true
1212 name:
1213 description: 姓名
1214 type: string
1215 status:
1216 description: 状态(1 启用,0 停用)
1217 type: string
1218 mobile:
1219 description: 登录手机
1220 type: string
1221 email:
1222 description: 登录邮箱
1223 type: string
1224 UserPagerResponseModel:
刘洪青0fb603f2018-08-09 10:54:08 +08001225 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001226 - $ref: '#/components/schemas/PagerResponseModel'
1227 - type: object
1228 properties:
刘洪青0fb603f2018-08-09 10:54:08 +08001229 items:
刘洪青1d10ee82018-08-16 10:08:36 +08001230 type: array
1231 items:
1232 $ref: '#/components/schemas/User'
刘洪青0fb603f2018-08-09 10:54:08 +08001233 Group:
1234 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001235 - $ref: '#/components/schemas/BaseDomain'
1236 - type: object
1237 properties:
1238 code:
1239 description: 代码
1240 type: string
1241 name:
1242 description: 名称
1243 type: string
1244 memo:
1245 description: 备注
1246 type: string
1247 status:
1248 description: 状态(1 启用,0 停用)
1249 type: string
1250 GroupPagerResponseModel:
刘洪青0fb603f2018-08-09 10:54:08 +08001251 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001252 - $ref: '#/components/schemas/PagerResponseModel'
1253 - type: object
1254 properties:
刘洪青0fb603f2018-08-09 10:54:08 +08001255 items:
刘洪青1d10ee82018-08-16 10:08:36 +08001256 type: array
1257 items:
1258 $ref: '#/components/schemas/Group'
刘洪青0fb603f2018-08-09 10:54:08 +08001259 Role:
1260 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001261 - $ref: '#/components/schemas/BaseDomain'
1262 - type: object
1263 properties:
1264 code:
1265 description: 代码
1266 type: string
1267 name:
1268 description: 名称
1269 type: string
1270 memo:
1271 description: 备注
1272 type: string
1273 status:
1274 description: 状态(1 启用,0 停用)
1275 type: string
1276 RolePagerResponseModel:
刘洪青0fb603f2018-08-09 10:54:08 +08001277 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001278 - $ref: '#/components/schemas/PagerResponseModel'
1279 - type: object
1280 properties:
刘洪青0fb603f2018-08-09 10:54:08 +08001281 items:
刘洪青1d10ee82018-08-16 10:08:36 +08001282 type: array
1283 items:
1284 $ref: '#/components/schemas/Role'
1285 UserGroup:
刘洪青0fb603f2018-08-09 10:54:08 +08001286 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001287 - $ref: '#/components/schemas/BaseDomain'
1288 - type: object
1289 properties:
刘洪青6fd78db2018-08-16 12:32:34 +08001290 userId:
1291 description: 用户ID
刘洪青1d10ee82018-08-16 10:08:36 +08001292 type: string
1293 groupId:
1294 description: 用户组ID
1295 type: string
1296 UserGroupPagerResponseModel:
刘洪青0fb603f2018-08-09 10:54:08 +08001297 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001298 - $ref: '#/components/schemas/PagerResponseModel'
1299 - type: object
1300 properties:
刘洪青0fb603f2018-08-09 10:54:08 +08001301 items:
刘洪青1d10ee82018-08-16 10:08:36 +08001302 type: array
1303 items:
1304 $ref: '#/components/schemas/UserGroup'
1305 UserGroups:
刘洪青0fb603f2018-08-09 10:54:08 +08001306 properties:
刘洪青1d10ee82018-08-16 10:08:36 +08001307 userGroups:
刘洪青0fb603f2018-08-09 10:54:08 +08001308 type: array
1309 items:
刘洪青1d10ee82018-08-16 10:08:36 +08001310 $ref: '#/components/schemas/UserGroup'
刘洪青0fb603f2018-08-09 10:54:08 +08001311 UserRole:
1312 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001313 - $ref: '#/components/schemas/BaseDomain'
1314 - type: object
1315 properties:
刘洪青6fd78db2018-08-16 12:32:34 +08001316 userId:
1317 description: 用户ID
刘洪青1d10ee82018-08-16 10:08:36 +08001318 type: string
刘洪青6fd78db2018-08-16 12:32:34 +08001319 roleId:
1320 description: 角色ID
刘洪青1d10ee82018-08-16 10:08:36 +08001321 type: string
1322 UserRolePagerResponseModel:
刘洪青0fb603f2018-08-09 10:54:08 +08001323 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001324 - $ref: '#/components/schemas/PagerResponseModel'
1325 - type: object
1326 properties:
刘洪青0fb603f2018-08-09 10:54:08 +08001327 items:
刘洪青1d10ee82018-08-16 10:08:36 +08001328 type: array
1329 items:
1330 $ref: '#/components/schemas/UserRole'
刘洪青0fb603f2018-08-09 10:54:08 +08001331 UserRoles:
1332 properties:
1333 userRoles:
1334 type: array
1335 items:
1336 $ref: '#/components/schemas/UserRole'
1337 GroupRole:
1338 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001339 - $ref: '#/components/schemas/BaseDomain'
1340 - type: object
1341 properties:
1342 groupId:
1343 description: 用户组ID
1344 type: string
刘洪青6fd78db2018-08-16 12:32:34 +08001345 roleId:
1346 description: 角色ID
刘洪青1d10ee82018-08-16 10:08:36 +08001347 type: string
1348 GroupRolePagerResponseModel:
刘洪青0fb603f2018-08-09 10:54:08 +08001349 allOf:
刘洪青1d10ee82018-08-16 10:08:36 +08001350 - $ref: '#/components/schemas/PagerResponseModel'
1351 - type: object
1352 properties:
刘洪青0fb603f2018-08-09 10:54:08 +08001353 items:
刘洪青1d10ee82018-08-16 10:08:36 +08001354 type: array
1355 items:
1356 $ref: '#/components/schemas/GroupRole'
刘洪青0fb603f2018-08-09 10:54:08 +08001357 GroupRoles:
1358 properties:
1359 groupRoles:
1360 type: array
1361 items:
1362 $ref: '#/components/schemas/GroupRole'