From c9e4f4965a1d9d904dc347bf5f1ac8aee4f51178 Mon Sep 17 00:00:00 2001 From: chenhaojie Date: Sat, 29 Jun 2024 20:48:27 +0800 Subject: [PATCH] =?UTF-8?q?das=E6=8E=A5=E5=8F=A3=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/api_list.md | 215 +++++++++++++++++++++++++------------------ 1 file changed, 124 insertions(+), 91 deletions(-) diff --git a/docs/api/api_list.md b/docs/api/api_list.md index 0fc9fe2c..43f16af8 100644 --- a/docs/api/api_list.md +++ b/docs/api/api_list.md @@ -23,28 +23,33 @@ # API接口一览表 -| 接口分类 | 接口描述 | API接口 | 权限 | -|:-----:| :------- |:--------------------------|-----------------| -| 系统登录 | 1.1、获取验证码 | /api/auth/captchaImage | | -| 系统登录 | 1.2、系统登录 | /api/auth/login | | -| 系统登录 | 1.3、退出登录 | /api/auth/logout | | -| 系统登录 | 1.4、修改密码 | /api/auth/password/change | | -| 菜单管理 | 2.1、新增菜单 | /api/menus/add | | -| 菜单管理 | 2.2、查询菜单 | /api/menus/query | | -| 菜单管理 | 2.3、更新菜单 | /api/menus/update | | -| 菜单管理 | 2.4、删除菜单 | /api/menus/delete | | -| 公司机构 | 3.1、公司机构查询 | /api/org/query | | -| 公司机构 | 3.2、添加机构信息 | /api/org/add | | -| 公司机构 | 3.3、修改机构信息 | /api/org/update | | -| 公司机构 | 3.4、删除指定机构 | /api/org/delete | | -| 职员操作 | 4.1、职员查询 | /api/user/query | | -| 职员操作 | 4.2、职员创建 | /api/user/add | | -| 职员操作 | 4.3、职员修改 | /api/user/update | | -| 职员操作 | 4.4、职员删除 | /api/user/delete | | -| 系统角色 | 5.1、系统角色查询 | /api/user/getSysRole | | -| 系统角色 | 5.2、系统角色删除 | /api/user/deleteSysRole | | -| 系统角色 | 5.3、系统角色新增 | /api/user/addSysRole | | -| 系统角色 | 5.4、角色权限查询 | /api/user/getAuthorityById | | +| 接口分类 | 接口描述 | API接口 | 权限 | +|:-----:|:------------------|:----------------------------------|-| +| 系统登录 | 1.1、获取验证码 | /api/auth/captchaImage | | +| 系统登录 | 1.2、系统登录 | /api/auth/login | | +| 系统登录 | 1.3、退出登录 | /api/auth/logout | | +| 系统登录 | 1.4、修改密码 | /api/auth/password/changePassword | | +| 菜单管理 | 2.1、新增菜单 | /api/menus/add | SYS_AUTHORITY_ID_ADMIN | +| 菜单管理 | 2.2、查询菜单 | /api/menus/query | | +| 菜单管理 | 2.3、更新菜单 | /api/menus/update |SYS_AUTHORITY_ID_ADMIN | +| 菜单管理 | 2.4、删除菜单 | /api/menus/delete |SYS_AUTHORITY_ID_ADMIN | +| 菜单管理 | 2.5、获取所有菜单信息 | /api/menus/list | | +| 菜单管理 | 2.6、查询登录账号所绑定的菜单树 | /api/menus/tree | | +| 公司机构 | 3.1、公司机构查询 | /api/org/query | | +| 公司机构 | 3.2、添加机构信息 | /api/org/add |SYS_AUTHORITY_ID_ADMIN | +| 公司机构 | 3.3、修改机构信息 | /api/org/update |SYS_AUTHORITY_ID_ADMIN | +| 公司机构 | 3.4、删除指定机构 | /api/org/delete | SYS_AUTHORITY_ID_ADMIN| +| 公司机构 | 3.5、获取所有的公司机构 | /api/org/list | | +| 职员操作 | 4.1、职员查询 | /api/user/query | | +| 职员操作 | 4.2、职员创建 | /api/user/add |SYS_AUTHORITY_ID_ADMIN | +| 职员操作 | 4.3、职员修改 | /api/user/update |SYS_AUTHORITY_ID_ADMIN | +| 职员操作 | 4.4、职员删除 | /api/user/delete |SYS_AUTHORITY_ID_ADMIN | +| 职员操作 | 4.5、根据id更新职员信息 | /api/user/updateById | | +| 系统角色 | 5.1、系统角色查询 | /api/role/query | | +| 系统角色 | 5.2、系统角色删除 | /api/role/delete |SYS_AUTHORITY_ID_ADMIN | +| 系统角色 | 5.3、系统角色新增 | /api/role/add | SYS_AUTHORITY_ID_ADMIN| +| 系统角色 | 5.4、系统角色新增 | /api/role/update | SYS_AUTHORITY_ID_ADMIN| +| 系统角色 | 5.5、根据角色id获取角色权限信息 | /api/role/getAuthorityById | | ## 1.1、验证码获取 > /api/auth/captchaImage @@ -83,21 +88,23 @@ ```json { - "userName":"xx", - "password":"xxx", - "code":"xxx", - "key":"xxx" + "userName":"test", + "password":"test123", + "key":"ef4a4e7230a14e7ebbb657c135be2945", + "keep":true, + "code":"4OEE" } ``` 入参描述 -| 参数名 | 参数类型 | 可选 | 描述 | -| -------- | -------- | ---- |------| -| userName | String | no | 用户名 | -| password | String | no | 用户密码 | -| code | String | no | 验证码 | -| key | String | no | 唯一标志 | +| 参数名 | 参数类型 | 可选 | 描述 | +| -------- |---------| ---- |------| +| userName | String | no | 用户名 | +| password | String | no | 用户密码 | +| code | String | no | 验证码 | +| key | String | no | 唯一标志 | +| keep | boolean | no | 是否记住 | 调用成功返回示例 @@ -107,12 +114,18 @@ "success": true, "data": { "sysUser": { - "id": 1, + "id": "73218693257382912", "account": "admin", - "userName": "admin" + "userName": "管理员", + "orgId": "1", + "authorities": [ + 103, + 101, + 102 + ] }, - "refreshToken": "6dfa2fe87b0d44538e26481c01c02d16", - "token": "85487b052fd34c36a0482be56e8532f0" + "refreshToken": "966333eee8b74f83b04cbd4d2e57695e", + "token": "3090c84d828c402a86d00c0d43bb3783" }, "msg": "操作成功" } @@ -120,9 +133,22 @@ 调用成功返回描述 -| 变量名 | 变量类型 | 可为NULL | 描述 | -| -------------------- |--------| -------- | -------------------------- | -| token | String | No | 令牌(未加密) | +| 变量名 | 变量类型 | 可为NULL | 描述 | +| -------------------- |--------| -------- |-----------| +| token | String | No | 令牌(未加密) | +| refreshToken | String | No | 刷新令牌(未加密) | +| sysUser | String | No | 用户信息 | + +sysUser描述 + +| 变量名 | 变量类型 | 可为NULL | 描述 | +|---------------------|--------| -------- |--------| +| id | String | No | 主键id | +| account | String | No | 账户名称 | +| userName | String | No | 用户名称 | +| orgId | String | No | 组织机构id | +| authorities | List | No | 权限id列表 | + ## 1.3、退出登录 @@ -146,15 +172,15 @@ 修改登录密码，POST请求 -> /api/auth/password/change +> /api/auth/changePassword 入参示例 ```json { - "userName":"xx", - "oldPassword":"xx", - "newPassword":"xxx", + "id":"1489", + "oldPassword":"test123", + "newPassword":"test123456" } ``` @@ -164,15 +190,15 @@ | ----------- | -------- | ---- | ------ | | oldPassword | String | NO | 旧密码 | | newPassword | String | NO | 新密码 | -| userName | String | NO | 用户名 | +| id | String | NO | 用户名 | 调用成功返回示例 ```json { - "code":200, - "msg":"修改成功", - "data":null + "code": 200, + "success": true, + "msg": "密码修改成功" } ``` @@ -181,9 +207,10 @@ ## 2.1、新增菜单 -```java -请求接口 /api/menus/add -``` + +新增菜单接口，POST请求 + +> /api/menus/add 入参定义 @@ -197,11 +224,7 @@ "funParam": "param", "authorityId": "123", "parentMenuId": "0", - "revision": 1, - "createdBy": "aaa", - "createdTime": 123456, - "updatedBy": "aaa", - "updatedTime": 12345 + "revision": 1 } ``` 入参描述 @@ -244,52 +267,63 @@ ## 2.2、查询菜单 -```java -请求接口 /api/menus/query -``` + +查询菜单接口，分页查询，POST请求 + +> /api/menus/query + 入参定义 ```json { - "parentMenuId": "0" + "parentMenuId": "0", + "pageSize": 1, + "pageNum": 1 } ``` +入参描述 + +| 参数名 | 参数类型 | 可选 | 描述 | +| ----------- |---------| ---- |--------| +| parentMenuId | Long | YES | 上级菜单ID | +| pageSize | Integer | YES | 分页大小 | +| pageNum | Integer | YES | 当前页数 | + + 调用成功返回示例 ```json { - "code": 200, - "msg": "操作成功", - "success": true, - "data": [ - { - "id": "123", - "menuName": "菜单1", - "menuOrder": 1, - "menuIcon": "icon1", - "funType": 1, - "funParam": "param", - "authorityId": "123", - "parentMenuId": "0", - "revision": 1, - "createdBy": "aaa", - "createdTime": 123456, - "updatedBy": "aaa", - "updatedTime": 12345 - } - ] + "total": 9, + "rows": [ + { + "createdBy": "aaa", + "createdTime": "2024-06-27 07:08:23", + "updatedBy": "aaa", + "updatedTime": "2024-06-27 08:38:16", + "revision": 2, + "id": "73261935099379712", + "menuName": "首页", + "menuOrder": 0, + "menuIcon": "el-icon-HomeFilled", + "funType": 1, + "funParam": "/dashboard.vue", + "parentMenuId": 1 + } + ], + "code": 200, + "msg": "查询成功" } ``` ## 2.3、更新菜单 -```java -请求接口 -/api/menus/update +更新菜单接口，post请求 + +> /api/menus/update -``` 入参定义 ```json @@ -320,13 +354,14 @@ ## 2.4、删除菜单 -```java -请求接口 /api/menus/delete -``` +删除菜单接口，post请求 + +> /api/menus/delete + 入参定义 ```json { - "id": "" + "id": "73261978251165698" } ``` 调用成功返回示例 @@ -335,16 +370,14 @@ { "code":"200", "msg":"成功", -"data":"null", "success": true } ``` ## 2.5、获取所有菜单 -```java -请求接口 /api/menus/list -``` +获取所有菜单接口，post请求 +> /api/menus/list 入参定义