das接口文档修改

This commit is contained in:
chenhaojie 2024-06-26 15:08:23 +08:00
parent 22ae74d761
commit 9db5556eca
2 changed files with 64 additions and 48 deletions

View File

@ -26,7 +26,6 @@
<result property="email" column="email" jdbcType="VARCHAR"/> <result property="email" column="email" jdbcType="VARCHAR"/>
<result property="phone" column="phone" jdbcType="VARCHAR"/> <result property="phone" column="phone" jdbcType="VARCHAR"/>
<result property="orgId" column="org_id" jdbcType="VARCHAR"/> <result property="orgId" column="org_id" jdbcType="VARCHAR"/>
<result property="lastLogin" column="last_login" jdbcType="VARCHAR"/>
<result property="revision" column="revision" jdbcType="VARCHAR"/> <result property="revision" column="revision" jdbcType="VARCHAR"/>
<collection property="roleList" column="id" ofType="com.das.modules.auth.domain.vo.SysUserRoleVo" select="queryRoleByUserId"/> <collection property="roleList" column="id" ofType="com.das.modules.auth.domain.vo.SysUserRoleVo" select="queryRoleByUserId"/>
</resultMap> </resultMap>

View File

@ -772,35 +772,46 @@
```json ```json
{ {
"code":"200", "total": 1,
"msg":"调用成功", "rows": [
"data": [
{ {
"id": "xxxx", "id": 73238484643741696,
"account": "xxx", "account": "test1",
"password": "xxx", "userName": "测试1",
"userName": "xxx", "revision": 1,
"email":"xxx", "phone": "1231212",
"phone":"xxx", "email": "测试",
"orgId":"xxx" "orgId": 1,
}, "roleList": [
{ {
... "id": 73220290639036416,
"roleCode": "1212",
"roleName": "测试角色1",
"revision": 1
},
{
"id": 73212978522226688,
"roleCode": "0011",
"roleName": "测试角色",
"revision": 1
}
]
} }
], ],
"success": true "code": 200,
"msg": "查询成功"
} }
``` ```
| 变量名 | 变量类型 | 可为NULL | 描述 | | 变量名 | 变量类型 | 可为NULL | 描述 |
| -------- | -------- | -------- | ------------------ | | -------- |--------| -------- |------------|
| id | BIGINT | No | 主键(雪花算法生成) | | id | BIGINT | No | 主键(雪花算法生成) |
| account | String | No | 登录账号 | | account | String | No | 登录账号 |
| password | String | No | 加密后的密码 | | userName | String | No | 职员名称 |
| userName | String | No | 职员名称 | | email | String | No | 职员邮箱 |
| email | String | No | 职员邮箱 | | phone | String | No | 职员联系电话 |
| phone | String | No | 职员联系电话 | | orgId | BIGINT | No | 所属机构ID |
| orgId | BIGINT | No | 所属机构ID | | roleList | List | No | 角色集合 |
## 职员创建 ## 职员创建
@ -817,29 +828,37 @@
"userName": "xxx", "userName": "xxx",
"email":"xxx", "email":"xxx",
"phone":"xxx", "phone":"xxx",
"orgId":"xxx" "orgId":"xxx",
"roleList":[73220290639036416,73212978522226688]
} }
``` ```
入参描述 入参描述
| 变量名 | 变量类型 | 可为NULL | 描述 | | 变量名 | 变量类型 | 可为NULL | 描述 |
| -------- | -------- | -------- | ------------ | | -------- |--------| -------- |--------|
| account | String | No | 登录账号 | | account | String | No | 登录账号 |
| password | String | No | 加密后的密码 | | password | String | No | 加密后的密码 |
| userName | String | No | 职员名称 | | userName | String | No | 职员名称 |
| email | String | No | 职员邮箱 | | email | String | No | 职员邮箱 |
| phone | String | No | 职员联系电话 | | phone | String | No | 职员联系电话 |
| orgId | BIGINT | No | 所属机构ID | | orgId | BIGINT | No | 所属机构ID |
| roleList | List | No | 角色id集合 |
调用成功返回示例 调用成功返回示例
```json ```json
{ {
"code":"200", "code": 200,
"msg":"创建成功", "success": true,
"data":"null", "data": {
"success": true "account": "test1",
"roleList": [
73220290639036416,
73212978522226688
]
},
"msg": "操作成功"
} }
``` ```
@ -857,11 +876,11 @@
{ {
"id":"xxx", "id":"xxx",
"account": "xxx", "account": "xxx",
"password": "xxx",
"userName": "xxx", "userName": "xxx",
"email":"xxx", "email":"xxx",
"phone":"xxx", "phone":"xxx",
"orgId":"xxx" "orgId":"xxx",
"roleList":[73220290639036416,73212978522226688]
} }
``` ```
@ -871,20 +890,19 @@
| -------- | -------- | -------- | ------------------ | | -------- | -------- | -------- | ------------------ |
| id | BIGINT | No | 主键(雪花算法生成) | | id | BIGINT | No | 主键(雪花算法生成) |
| account | String | No | 登录账号 | | account | String | No | 登录账号 |
| password | String | No | 加密后的密码 |
| userName | String | No | 职员名称 | | userName | String | No | 职员名称 |
| email | String | No | 职员邮箱 | | email | String | No | 职员邮箱 |
| phone | String | No | 职员联系电话 | | phone | String | No | 职员联系电话 |
| orgId | BIGINT | No | 所属机构ID | | orgId | BIGINT | No | 所属机构ID |
| roleList | List | No | 角色id集合 |
调用成功返回示例 调用成功返回示例
```json ```json
{ {
"code":"200", "code": 200,
"msg":"修改成功", "success": true,
"data":"null", "msg": "操作成功"
"success": true
} }
``` ```
@ -912,10 +930,9 @@
```json ```json
{ {
"code":"200", "code": 200,
"msg":"修改成功", "success": true,
"data":"null", "msg": "操作成功"
"success": true
} }
``` ```