文档整理
diff --git "a/doc/\346\216\245\345\217\243\350\247\204\350\214\203\350\256\276\350\256\241/README.MD" "b/doc/\346\216\245\345\217\243\350\247\204\350\214\203\350\256\276\350\256\241/README.MD"
index 608be80..6fb23e1 100644
--- "a/doc/\346\216\245\345\217\243\350\247\204\350\214\203\350\256\276\350\256\241/README.MD"
+++ "b/doc/\346\216\245\345\217\243\350\247\204\350\214\203\350\256\276\350\256\241/README.MD"
@@ -1,9 +1,20 @@
+
+## 文档编辑说明
+
+打开 `http://101.231.81.202:9080/swagger-editor/`
+
+
+File > Import URL
+
+输入 `http://101.231.81.202:9080/gerrit/gitweb?p=leave-school/microservice.git;a=blob_plain;f=doc/接口规范设计/sample-user.yaml;hb=refs/heads/develop`
+
+
## 文档查看说明
-打开 http://101.231.81.202:9080/swagger-ui/
+打开 `http://101.231.81.202:9080/swagger-ui/`
在 Explore 框中输入文档地址
-http://101.231.81.202:9080/gerrit/gitweb?p=leave-school/microservice.git;a=blob_plain;f=doc/接口规范设计/sample-user.yaml;hb=refs/heads/develop
+`http://101.231.81.202:9080/gerrit/gitweb?p=leave-school/microservice.git;a=blob_plain;f=doc/接口规范设计/sample-user.yaml;hb=refs/heads/develop`
diff --git "a/doc/\346\216\245\345\217\243\350\247\204\350\214\203\350\256\276\350\256\241/sample-user.yaml" "b/doc/\346\216\245\345\217\243\350\247\204\350\214\203\350\256\276\350\256\241/sample-user.yaml"
index 3fbe5db..3b2ad1e 100644
--- "a/doc/\346\216\245\345\217\243\350\247\204\350\214\203\350\256\276\350\256\241/sample-user.yaml"
+++ "b/doc/\346\216\245\345\217\243\350\247\204\350\214\203\350\256\276\350\256\241/sample-user.yaml"
@@ -5,7 +5,7 @@
servers:
- url: 'http://localhost:10010/api/v1'
paths:
- '/admin/users':
+ /admin/users:
get:
summary: 查询用户
operationId: admin-users-list
@@ -52,7 +52,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/UserPager'
+ $ref: '#/components/schemas/UserPagerResponseModel'
default:
description: unexpected error
content:
@@ -71,26 +71,25 @@
$ref: '#/components/schemas/User'
examples:
test1:
- value: {
- "companyId": "1",
- "deleted": false,
- "addAccount": "admin",
- "username": "test1",
- "password": "test1",
- "enabled": true,
- "accountNonExpired": true,
- "accountNonLocked": true,
- "credentialsNonExpired": true,
- "name": "测试1",
- "status": "1",
- }
+ value:
+ companyId: '1'
+ deleted: false
+ addAccount: admin
+ username: test1
+ password: test1
+ enabled: true
+ accountNonExpired: true
+ accountNonLocked: true
+ credentialsNonExpired: true
+ name: 测试1
+ status: '1'
responses:
'200':
description: 创建成功
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
value:
@@ -113,17 +112,16 @@
$ref: '#/components/schemas/User'
examples:
test1:
- value: {
- "id": "1",
- "status": "0"
- }
+ value:
+ id: '1'
+ status: '0'
responses:
'200':
description: 修改成功
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
value:
@@ -178,7 +176,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
value:
@@ -242,7 +240,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/GroupUserPager'
+ $ref: '#/components/schemas/UserGroupPagerResponseModel'
default:
description: unexpected error
content:
@@ -265,19 +263,18 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/GroupUsers'
+ $ref: '#/components/schemas/UserGroups'
responses:
'200':
description: 设置成功
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
- value: {
- "success": "info.set.success"
- }
+ value:
+ success: info.set.success
default:
description: unexpected error
content:
@@ -337,7 +334,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/UserRolePager'
+ $ref: '#/components/schemas/UserRolePagerResponseModel'
default:
description: unexpected error
content:
@@ -367,19 +364,18 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
- value: {
- "success": "info.set.success"
- }
+ value:
+ success: info.set.success
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
- '/admin/groups':
+ /admin/groups:
get:
summary: 查询用户组
operationId: admin-groups-list
@@ -426,7 +422,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/GroupPager'
+ $ref: '#/components/schemas/GroupPagerResponseModel'
default:
description: unexpected error
content:
@@ -445,22 +441,21 @@
$ref: '#/components/schemas/Group'
examples:
test1:
- value: {
- "companyId": "1",
- "deleted": false,
- "addAccount": "admin",
- "code": "group1",
- "name": "测试组1",
- "memo": "",
- "status": "1"
- }
+ value:
+ companyId: '1'
+ deleted: false
+ addAccount: admin
+ code: group1
+ name: 测试组1
+ memo: ''
+ status: '1'
responses:
'200':
description: 创建成功
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
value:
@@ -483,17 +478,16 @@
$ref: '#/components/schemas/Group'
examples:
test1:
- value: {
- "id": "1",
- "status": "0"
- }
+ value:
+ id: '1'
+ status: '0'
responses:
'200':
description: 修改成功
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
value:
@@ -548,7 +542,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
value:
@@ -612,7 +606,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/GroupUserPager'
+ $ref: '#/components/schemas/UserGroupPagerResponseModel'
default:
description: unexpected error
content:
@@ -635,19 +629,18 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/GroupUsers'
+ $ref: '#/components/schemas/UserGroups'
responses:
'200':
description: 设置成功
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
- value: {
- "success": "info.set.success"
- }
+ value:
+ success: info.set.success
default:
description: unexpected error
content:
@@ -707,7 +700,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/GroupRolePager'
+ $ref: '#/components/schemas/GroupRolePagerResponseModel'
default:
description: unexpected error
content:
@@ -737,19 +730,18 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
- value: {
- "success": "info.set.success"
- }
+ value:
+ success: info.set.success
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
- '/admin/roles':
+ /admin/roles:
get:
summary: 查询角色
operationId: admin-roles-list
@@ -796,7 +788,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/RolePager'
+ $ref: '#/components/schemas/RolePagerResponseModel'
default:
description: unexpected error
content:
@@ -815,22 +807,21 @@
$ref: '#/components/schemas/Role'
examples:
test1:
- value: {
- "companyId": "1",
- "deleted": false,
- "addAccount": "admin",
- "code": "role1",
- "name": "测试角色1",
- "memo": "",
- "status": "1"
- }
+ value:
+ companyId: '1'
+ deleted: false
+ addAccount: admin
+ code: role1
+ name: 测试角色1
+ memo: ''
+ status: '1'
responses:
'200':
description: 创建成功
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
value:
@@ -853,17 +844,16 @@
$ref: '#/components/schemas/Role'
examples:
test1:
- value: {
- "id": "1",
- "status": "0"
- }
+ value:
+ id: '1'
+ status: '0'
responses:
'200':
description: 修改成功
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
value:
@@ -918,7 +908,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
value:
@@ -982,7 +972,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/UserRolePager'
+ $ref: '#/components/schemas/UserRolePagerResponseModel'
default:
description: unexpected error
content:
@@ -1012,12 +1002,11 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
- value: {
- "success": "info.set.success"
- }
+ value:
+ success: info.set.success
default:
description: unexpected error
content:
@@ -1077,7 +1066,7 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/GroupRolePager'
+ $ref: '#/components/schemas/GroupRolePagerResponseModel'
default:
description: unexpected error
content:
@@ -1107,12 +1096,11 @@
content:
application/json:
schema:
- $ref: '#/components/schemas/Success'
+ $ref: '#/components/schemas/SuccessResponseModel'
examples:
success:
- value: {
- "success": "info.set.success"
- }
+ value:
+ success: info.set.success
default:
description: unexpected error
content:
@@ -1131,7 +1119,7 @@
format: int32
message:
type: string
- Success:
+ SuccessResponseModel:
properties:
success:
type: string
@@ -1187,151 +1175,151 @@
format: date
User:
allOf:
- - $ref: '#/components/schemas/BaseDomain'
- - type: object
- properties:
- username:
- description: 用户名
- type: string
- password:
- description: 密码
- type: string
- format: password
- enabled:
- description: 是否可用，1 可用，0 不可用，默认：1
- type: boolean
- default: true
- accountNonExpired:
- description: 账号未过期，1 未过期，0 过期，默认：1
- type: boolean
- default: true
- accountNonLocked:
- description: 账号未锁定，1 未锁定，0 锁定，默认：1
- type: boolean
- default: true
- credentialsNonExpired:
- description: 密码未过期，1 未过期，0 过期，默认：1
- type: boolean
- default: true
- name:
- description: 姓名
- type: string
- status:
- description: 状态（1 启用，0 停用）
- type: string
- mobile:
- description: 登录手机
- type: string
- email:
- description: 登录邮箱
- type: string
- UserPager:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ username:
+ description: 用户名
+ type: string
+ password:
+ description: 密码
+ type: string
+ format: password
+ enabled:
+ description: 是否可用，1 可用，0 不可用，默认：1
+ type: boolean
+ default: true
+ accountNonExpired:
+ description: 账号未过期，1 未过期，0 过期，默认：1
+ type: boolean
+ default: true
+ accountNonLocked:
+ description: 账号未锁定，1 未锁定，0 锁定，默认：1
+ type: boolean
+ default: true
+ credentialsNonExpired:
+ description: 密码未过期，1 未过期，0 过期，默认：1
+ type: boolean
+ default: true
+ name:
+ description: 姓名
+ type: string
+ status:
+ description: 状态（1 启用，0 停用）
+ type: string
+ mobile:
+ description: 登录手机
+ type: string
+ email:
+ description: 登录邮箱
+ type: string
+ UserPagerResponseModel:
allOf:
- - $ref: '#/components/schemas/PagerResponseModel'
- - type: object
- properties:
- items:
- type: array
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
items:
- $ref: '#/components/schemas/User'
+ type: array
+ items:
+ $ref: '#/components/schemas/User'
Group:
allOf:
- - $ref: '#/components/schemas/BaseDomain'
- - type: object
- properties:
- code:
- description: 代码
- type: string
- name:
- description: 名称
- type: string
- memo:
- description: 备注
- type: string
- status:
- description: 状态（1 启用，0 停用）
- type: string
- GroupPager:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ code:
+ description: 代码
+ type: string
+ name:
+ description: 名称
+ type: string
+ memo:
+ description: 备注
+ type: string
+ status:
+ description: 状态（1 启用，0 停用）
+ type: string
+ GroupPagerResponseModel:
allOf:
- - $ref: '#/components/schemas/PagerResponseModel'
- - type: object
- properties:
- items:
- type: array
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
items:
- $ref: '#/components/schemas/Group'
+ type: array
+ items:
+ $ref: '#/components/schemas/Group'
Role:
allOf:
- - $ref: '#/components/schemas/BaseDomain'
- - type: object
- properties:
- code:
- description: 代码
- type: string
- name:
- description: 名称
- type: string
- memo:
- description: 备注
- type: string
- status:
- description: 状态（1 启用，0 停用）
- type: string
- RolePager:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ code:
+ description: 代码
+ type: string
+ name:
+ description: 名称
+ type: string
+ memo:
+ description: 备注
+ type: string
+ status:
+ description: 状态（1 启用，0 停用）
+ type: string
+ RolePagerResponseModel:
allOf:
- - $ref: '#/components/schemas/PagerResponseModel'
- - type: object
- properties:
- items:
- type: array
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
items:
- $ref: '#/components/schemas/Role'
- GroupUser:
+ type: array
+ items:
+ $ref: '#/components/schemas/Role'
+ UserGroup:
allOf:
- - $ref: '#/components/schemas/BaseDomain'
- - type: object
- properties:
- groupId:
- description: 用户组ID
- type: string
- username:
- description: 用户名
- type: string
- GroupUserPager:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ username:
+ description: 用户名
+ type: string
+ groupId:
+ description: 用户组ID
+ type: string
+ UserGroupPagerResponseModel:
allOf:
- - $ref: '#/components/schemas/PagerResponseModel'
- - type: object
- properties:
- items:
- type: array
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
items:
- $ref: '#/components/schemas/GroupUser'
- GroupUsers:
+ type: array
+ items:
+ $ref: '#/components/schemas/UserGroup'
+ UserGroups:
properties:
- groupUsers:
+ userGroups:
type: array
items:
- $ref: '#/components/schemas/GroupUser'
+ $ref: '#/components/schemas/UserGroup'
UserRole:
allOf:
- - $ref: '#/components/schemas/BaseDomain'
- - type: object
- properties:
- username:
- description: 用户名
- type: string
- rolecode:
- description: 角色代码
- type: string
- UserRolePager:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ username:
+ description: 用户名
+ type: string
+ rolecode:
+ description: 角色代码
+ type: string
+ UserRolePagerResponseModel:
allOf:
- - $ref: '#/components/schemas/PagerResponseModel'
- - type: object
- properties:
- items:
- type: array
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
items:
- $ref: '#/components/schemas/UserRole'
+ type: array
+ items:
+ $ref: '#/components/schemas/UserRole'
UserRoles:
properties:
userRoles:
@@ -1340,24 +1328,24 @@
$ref: '#/components/schemas/UserRole'
GroupRole:
allOf:
- - $ref: '#/components/schemas/BaseDomain'
- - type: object
- properties:
- groupId:
- description: 用户组ID
- type: string
- rolecode:
- description: 角色代码
- type: string
- GroupRolePager:
+ - $ref: '#/components/schemas/BaseDomain'
+ - type: object
+ properties:
+ groupId:
+ description: 用户组ID
+ type: string
+ rolecode:
+ description: 角色代码
+ type: string
+ GroupRolePagerResponseModel:
allOf:
- - $ref: '#/components/schemas/PagerResponseModel'
- - type: object
- properties:
- items:
- type: array
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
items:
- $ref: '#/components/schemas/GroupRole'
+ type: array
+ items:
+ $ref: '#/components/schemas/GroupRole'
GroupRoles:
properties:
groupRoles: