新增sample-user的接口规范文档
diff --git a/leaveschool/sample-user.yaml b/leaveschool/sample-user.yaml
new file mode 100644
index 0000000..f664329
--- /dev/null
+++ b/leaveschool/sample-user.yaml
@@ -0,0 +1,323 @@
+openapi: 3.0.0
+info:
+ version: 1.0.0
+ title: Sample User
+servers:
+ - url: 'http://localhost:10010/api/v1'
+paths:
+ '/admin/users':
+ get:
+ summary: 查询用户
+ operationId: admin-users-list
+ tags:
+ - Api1AdminUserController
+ parameters:
+ - name: pageIndex
+ in: query
+ description: 分页-页码
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 0
+ - name: pageSize
+ in: query
+ description: 分页-每页记录数
+ required: true
+ schema:
+ type: integer
+ format: int32
+ default: 20
+ - name: mapBean[username]
+ in: query
+ description: 查询条件-用户名
+ required: false
+ schema:
+ type: string
+ - name: mapBean[name]
+ in: query
+ description: 查询条件-姓名
+ required: false
+ schema:
+ type: string
+ - name: mapBean[status]
+ in: query
+ description: 查询条件-状态（1 启用，0 停用）
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ description: A paged array of users
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Users'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+
+ post:
+ summary: 创建用户
+ operationId: admin-users-create
+ tags:
+ - Api1AdminUserController
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $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"}
+ responses:
+ '200':
+ description: 创建成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value: {"success":"info.create.success"}
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+
+ put:
+ summary: 修改用户
+ operationId: admin-users-update
+ tags:
+ - Api1AdminUserController
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ examples:
+ test1:
+ value: {"id": "1", "status": "0"}
+ responses:
+ '200':
+ description: 修改成功
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value: {"success":"info.update.success"}
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+
+ '/admin/users/{id}':
+ get:
+ summary: 根据用户ID获取用户
+ operationId: admin-users-get
+ tags:
+ - Api1AdminUserController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Expected response to a valid request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/User'
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+
+ delete:
+ summary: 根据用户ID删除用户
+ operationId: admin-users-delete
+ tags:
+ - Api1AdminUserController
+ parameters:
+ - name: id
+ in: path
+ required: true
+ description: 用户ID
+ schema:
+ type: string
+ responses:
+ '200':
+ description: Expected response to a valid request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Success'
+ examples:
+ success:
+ value: {"success":"info.delete.success"}
+ default:
+ description: unexpected error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error'
+
+components:
+ schemas:
+ User:
+ properties:
+ id:
+ description: ID
+ type: string
+ companyId:
+ description: Company ID, 固定 1
+ type: string
+ deleted:
+ description: 是否删除
+ type: boolean
+ default: false
+ addAccount:
+ description: 创建人
+ type: string
+ addTime:
+ description: 创建时间
+ type: string
+ format: date
+ editAccount:
+ description: 修改人
+ type: string
+ editTime:
+ description: 修改时间
+ type: string
+ format: date
+ deleteAccount:
+ description: 删除人
+ type: string
+ deleteTime:
+ description: 删除时间
+ type: string
+ format: date
+ 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
+ Users:
+ allOf:
+ - $ref: '#/components/schemas/PagerResponseModel'
+ - type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: '#/components/schemas/User'
+
+ Group:
+ properties:
+ id:
+ type: string
+ companyId:
+ type: string
+ deleted:
+ type: boolean
+ default: false
+ addAccount:
+ type: string
+ addTime:
+ type: string
+ format: date
+ editAccount:
+ type: string
+ editTime:
+ type: string
+ format: date
+ deleteAccount:
+ type: string
+ deleteTime:
+ type: string
+ format: date
+ code:
+ type: string
+ name:
+ type: string
+ memo:
+ type: string
+ status:
+ type: string
+
+ PagerResponseModel:
+ properties:
+ pageIndex:
+ type: integer
+ format: int32
+ pageSize:
+ type: integer
+ format: int32
+ currentItemCount:
+ type: integer
+ format: int32
+ pageCount:
+ type: integer
+ format: int32
+ recordCount:
+ type: integer
+ format: int64
+
+ Success:
+ properties:
+ success:
+ type: string
+ Error:
+ required:
+ - code
+ - message
+ properties:
+ code:
+ type: integer
+ format: int32
+ message:
+ type: string