Commit 3ac9d3d2 authored by 赵啸非's avatar 赵啸非

修改接口文档

parent 498b820a
......@@ -274,7 +274,7 @@ size|Integer|否|每页条数,值为-1,查询所有记录
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
:------|:---|:------
code|Integer|结果码(-1.失败,1.成功)
msg|String|消息
data|object|数据对象
......@@ -282,7 +282,7 @@ data|object|数据对象
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
 data|array|结果集列表
  id|Long|用户ID
  loginName|String|登录名
  realName|String|用户名
......@@ -548,7 +548,7 @@ data|object|数据对象
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
 data|array|结果集列表
  id|Long|序号,主键,自增长
  name|String|角色名称
  roleCode|String|角色编码
......@@ -763,7 +763,7 @@ roleIdList|Arrays|否|角色ID列表,值为long
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
:------|:---|:------
code|Integer|结果码(-1.失败,1.成功)
msg|String|消息
data|object|数据对象
......@@ -771,7 +771,7 @@ data|object|数据对象
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
 data|array|结果集列表
  id|Long|序号,主键,自增长
  roleId|Long|角色ID
  userId|Long|用户ID
......@@ -862,7 +862,7 @@ parentId|Integer|否|通过父id查询子集
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
:------|:---|:------
code|Integer|结果码(-1.失败,1.成功)
msg|String|消息
data|object|数据对象
......@@ -870,7 +870,7 @@ data|object|数据对象
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
 data|array|结果集列表
  id|Long|菜单ID,主键,自增长
  name|String|菜单名称
  url|String|连接地址
......@@ -1247,7 +1247,7 @@ data|object|数据对象
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
 data|array|结果集列表
  id|Long|菜单ID,主键,自增长
  name|String|菜单名称
  url|String|连接地址
......@@ -1321,7 +1321,7 @@ data|object|数据对象
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
 data|array|结果集列表
  id|Long|ID,主键,自增长
  fileName|String|文件名称
  filePath|String|文件路径
......@@ -1518,7 +1518,7 @@ data|object|数据对象
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
 data|array|结果集列表
  id|Long|系统API的ID,主键,自增长
  systemServiceName|String|模块名称
  systemServiceCode|String|模块编码
......@@ -1745,7 +1745,7 @@ data|object|数据对象
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
 data|array|结果集列表
  id|Long|系统API的ID,主键,自增长
  systemServiceName|String|模块名称
  systemServiceCode|String|模块编码
......@@ -1964,7 +1964,7 @@ size|Integer|否|每页条数,值为-1,查询所有记录
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
:------|:---|:------
code|Integer|结果码(-1.失败,1.成功)
msg|String|消息
data|object|数据对象
......@@ -1972,7 +1972,7 @@ data|object|数据对象
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
 data|array|结果集列表
  id|Long|序号,主键,自增长
  name|String|参数名称
  firstOrganize|String|一级组织,如:平台配置
......@@ -2207,7 +2207,7 @@ size|Integer|否|每页条数,值为-1,查询所有记录
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
:------|:---|:------
code|Integer|结果码(-1.失败,1.成功)
msg|String|消息
data|object|数据对象
......@@ -2215,7 +2215,7 @@ data|object|数据对象
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
 data|array|结果集列表
  id|Long|序号,主键,自增长
  name|String|任务名称
  taskKey|String|任务关键字,区分任务执行流程
......@@ -2474,7 +2474,7 @@ size|Integer|否|每页条数,值为-1,查询所有记录
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
:------|:---|:------
code|Integer|结果码(-1.失败,1.成功)
msg|String|消息
data|object|数据对象
......@@ -2482,7 +2482,7 @@ data|object|数据对象
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
 data|array|结果集列表
  id|Long|序号,主键,自增长
  platformMark|String|平台标识
  userId|Long|用户id
......@@ -2570,113 +2570,6 @@ dict|object|字典对象
}
```
### 保存更新操作日志业务
**请求URL:** oper/log/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新操作日志业务:id为空时为新增保存,否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
platformMark|String|是|平台标识
userId|Long|是|用户id
userName|String|是|用户名称
loginName|String|是|用户登录名
requestUrl|String|是|请求地址
content|String|是|操作内容,记录操作具体信息,如修改前修改或的数据
ip|String|是|操作IP地址
logDate|Date|是|操作时间
operType|Integer|是|操作类型,(0.新增,1.修改,2.删除)
**请求样例:**
```
{
"platformMark":"zd7mbs",
"userId":3160,
"userName":"vl8g4v",
"loginName":"qk4e4v",
"requestUrl":"e2rkbv",
"content":"exflzy",
"ip":"hmem4i",
"logDate":"2022-06-02",
"operType":8740,
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码(-1.失败,1.成功)
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|序号,主键,自增长
  platformMark|String|平台标识
  userId|Long|用户id
  userName|String|用户名称
  loginName|String|用户登录名
  requestUrl|String|请求地址
  content|String|操作内容,记录操作具体信息,如修改前修改或的数据
  ip|String|操作IP地址
  logDate|Date|操作时间
  operType|Integer|操作类型,(0.新增,1.修改,2.删除)
  createTime|Date|创建时间
  createUserId|Long|创建用户
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除操作日志业务
**请求URL:** oper/log/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除操作日志业务
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/oper/log/delete?id=1&id=2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码(-1.失败,1.成功)|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
## 字典附录
### userType
字典参数key|字典参数值|其它
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment