Logo

项目地址

https://github.com/cuteJ/shop-server
= API

1. 概览

接口API文档。

1.1. 版本信息

版本 : 1.0

1.2. 联系方式

名字 : Li Xingping
邮箱 : lixingping233@gmail.com

1.3. URI scheme

域名 : 127.0.0.1:-1
基础路径 : /
方案 : HTTP

1.4. 标签

  • 不受保护 : Insecure Mgt Controller

  • 会话管理 : Session Mgt Controller

  • 地区数据 : Region Mgt Controller

  • 基础 : Infra System Controller

  • 应用相关 : App Brand Mgt Controller

  • 应用配置 : App Brand Controller

  • 微信小程序 : Ma User Controller

  • 数据字典 : Sys Metadata Controller

  • 用户登录 : Ma Auth Controller

  • 用户相关 : User Mgt Controller

  • 系统任务 : Sys Job Controller

  • 系统操作日志 : Sys Opt Log Controller

  • 系统（管理） : Login Mgt Controller

2. 全局响应CODE

全局响应CODE说明如下：

CODE 描述

400

请求失败

404

找不到资源

401

未授权

403

无权限

405

不支持的请求方法

415

不支持的请求头

500

应用内部错误

-1

系统繁忙，请稍后再试！

0

请求成功

30001

API请求参数校验不通过（如:NotBlank）

30002

实体或者方法参数约束校验不通过

65535

未定义的错误，请联系开发

3. 常量值对照

常量类型 常量编号 常量名称 常量备注 是否有效

1000

100000

是

是

1000

100001

否

是

1001

100100

男

是

1001

100101

女

是

1001

100102

未知

是

1002

100200

固定频率

是

1002

100201

每日时间段

是

1002

100202

CRON

是

1003

100300

运行中

是

1003

100301

暂停

是

1003

100302

失败

是

1004

100400

成功

是

1004

100401

失败

是

1005

100500

微信

是

1005

100501

用户名

是

3.1. C端用户登录流程

auth protocol

3.2. 用户登录API

用户登录 成功返回 token

3.2.1. 账号登录(maType=h5|web:用户名或者手机号登录)

POST /api/app/auth/{appNo}/{maType}/login
参数
类型 名称 说明 类型

Path

appNo
必填

应用编号（应用管理创建）

string

Path

maType
必填

平台类型

enum (h5, web)

Body

dto
必填

请求Body

请求Body
名称 说明 类型

username
必填

用户名|手机号
样例 : "11111111111"

string

password
必填

密码|手机验证码
样例 : "4034"

string

3.3. 响应

名称 说明 类型

hasUser
必填

是否已注册
样例 : true

boolean

token
必填

Token
样例 : "string"

string
HTTP请求示例
请求 path
/api/app/auth/100/h5/login
请求 body
{
  "username" : "11111111111",
  "password" : "4034"
}
HTTP响应示例
响应 200
{
  "hasUser" : true,
  "token" : "xxxxxxxxxxxxxxxxx"
}

3.3.3. 登陆接口

POST /api/app/auth/{appNo}/{maType}/ma_login
参数
类型 名称 说明 类型

Path

appNo
必填

应用编号（应用管理创建）

string

Path

maType
必填

小程序平台

enum (wx, swan, my, tt)

Body

dto
必填

请求Body

请求Body
名称 说明 类型

code
必填

code
样例 : "小程序登录code"

string
响应
名称 说明 类型

hasUser
必填

是否已注册
样例 : true

boolean

token
必填

Token
样例 : "string"

string
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/api/app/auth/100/wx/ma_login
请求 body
{
  "code" : "xxxxxxxx"
}
HTTP响应示例
响应 200
{
  "hasUser" : false,
  "token" : "xxxxxxxxxxx"
}

4. 资源

4.1. 不受保护

Insecure Mgt Controller

4.1.1. Avatar

GET /shop/api/insecure/avatar
参数
类型 名称 说明 类型

Query

code
必填

code

string

Query

size
必填

size

string
响应
HTTP代码 说明 类型

200

OK

无内容
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/insecure/avatar
请求 query
{
  "code" : "string",
  "size" : "string"
}

4.2. 会话管理

Session Mgt Controller

4.2.1. 注销用户

GET /shop/api/sys/force_logout
参数
类型 名称 说明 类型

Query

id
可选

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/force_logout
请求 query
{
  "id" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.2.2. 在线会话数

GET /shop/api/sys/online_total
响应
HTTP代码 说明 类型

200

OK

integer (int32)
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/online_total
HTTP响应示例
响应 200
0

4.2.3. 在线用户

GET /shop/api/sys/users_online
响应
HTTP代码 说明 类型

200

OK

< 系统在线用户 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/users_online
HTTP响应示例
响应 200
[ {
  "host" : "string",
  "id" : "string",
  "lastAccessTime" : "string",
  "startTimestamp" : "string",
  "status" : "string",
  "systemHost" : "string",
  "timeout" : 0,
  "userId" : "string",
  "username" : "string"
} ]

4.3. 地区数据

Region Mgt Controller

4.3.1. 所有数据

GET /shop/api/sys/region/all
响应
HTTP代码 说明 类型

200

OK

< 选择器 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/region/all
HTTP响应示例
响应 200
[ {
  "children" : [ {
    "children" : [ "..." ],
    "disabled" : false,
    "label" : "string",
    "value" : "string"
  } ],
  "disabled" : false,
  "label" : "string",
  "value" : "string"
} ]

4.3.2. 地区数据

GET /shop/api/sys/region/child/{parentId}
参数
类型 名称 说明 类型

Path

parentId
必填

parentId

string
响应
HTTP代码 说明 类型

200

OK

< 选择器 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/region/child/string
HTTP响应示例
响应 200
[ {
  "children" : [ {
    "children" : [ "..." ],
    "disabled" : false,
    "label" : "string",
    "value" : "string"
  } ],
  "disabled" : false,
  "label" : "string",
  "value" : "string"
} ]

4.3.3. 地区数据

GET /shop/api/sys/region/depth/{depth}
参数
类型 名称 说明 类型

Path

depth
必填

depth

integer (int32)
响应
HTTP代码 说明 类型

200

OK

< 选择器 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/region/depth/0
HTTP响应示例
响应 200
[ {
  "children" : [ {
    "children" : [ "..." ],
    "disabled" : false,
    "label" : "string",
    "value" : "string"
  } ],
  "disabled" : false,
  "label" : "string",
  "value" : "string"
} ]

4.3.4. 初始化数据

POST /shop/api/sys/region/init/{depth}
参数
类型 名称 说明 类型

Path

depth
必填

depth

integer (int32)

Body

data
必填

data

< string, string > map
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/region/init/0
请求 body
{ }
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.3.5. 地区列表

POST /shop/api/sys/region/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/region/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.3.6. 地区添加

POST /shop/api/sys/region/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

地区数据
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/region/save
请求 body
{
  "depth" : 0,
  "depthName" : "string",
  "firstLetter" : "string",
  "id" : "string",
  "jianPin" : "string",
  "name" : "string",
  "parentId" : "string",
  "pinYin" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4. 基础

Infra System Controller

4.4.1. API列表

POST /shop/api/sys/apiList/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/apiList/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.4.2. API移除

DELETE /shop/api/sys/apiList/remove/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/apiList/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.3. API添加

POST /shop/api/sys/apiList/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

系统API列表
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/apiList/save
请求 body
{
  "apiName" : "string",
  "apiTag" : "string",
  "apiUrl" : "string",
  "byOrder" : 0,
  "createdTime" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "parentId" : "string",
  "remark" : "string",
  "shiroCode" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.4. 系统权限列表

POST /shop/api/sys/authority/_list
参数
类型 名称 说明 类型

Query

params
可选

params

object
响应
HTTP代码 说明 类型

200

OK

< 系统API权限 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/authority/_list
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
[ {
  "action" : "string",
  "authorityName" : "string",
  "byOrder" : 0,
  "createdTime" : "string",
  "domain" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "module" : "string",
  "parentId" : "string",
  "remark" : "string"
} ]

4.4.5. 系统权限列表

POST /shop/api/sys/authority/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/authority/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.4.6. 系统权限移除

DELETE /shop/api/sys/authority/remove/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/authority/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.7. 系统权限添加

POST /shop/api/sys/authority/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

系统API权限
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/authority/save
请求 body
{
  "action" : "string",
  "authorityName" : "string",
  "byOrder" : 0,
  "createdTime" : "string",
  "domain" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "module" : "string",
  "parentId" : "string",
  "remark" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.8. 系统权限列表

POST /shop/api/sys/authority/select
参数
类型 名称 说明 类型

Query

params
必填

params

object
响应
HTTP代码 说明 类型

200

OK

< 系统API权限 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/authority/select
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
[ {
  "action" : "string",
  "authorityName" : "string",
  "byOrder" : 0,
  "createdTime" : "string",
  "domain" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "module" : "string",
  "parentId" : "string",
  "remark" : "string"
} ]

4.4.9. 系统权限列表

POST /shop/api/sys/authority/tree_list
参数
类型 名称 说明 类型

Query

params
可选

params

object
响应
HTTP代码 说明 类型

200

OK

< 权限 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/authority/tree_list
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
[ {
  "byOrder" : "string",
  "children" : [ {
    "byOrder" : "string",
    "children" : [ "..." ],
    "disabled" : true,
    "id" : "string",
    "label" : "string"
  } ],
  "disabled" : true,
  "id" : "string",
  "label" : "string"
} ]

4.4.10. 授权菜单API权限

POST /shop/api/sys/grant/menu_authorities
参数
类型 名称 说明 类型

Body

dto
必填

dto

授权请求
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/grant/menu_authorities
请求 body
{
  "grantIds" : [ "string" ],
  "halfPermissions" : [ "string" ],
  "permissions" : [ "string" ]
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.11. 授权角色API权限

POST /shop/api/sys/grant/role_authorities
参数
类型 名称 说明 类型

Body

dto
必填

dto

授权请求
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/grant/role_authorities
请求 body
{
  "grantIds" : [ "string" ],
  "halfPermissions" : [ "string" ],
  "permissions" : [ "string" ]
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.12. 授权角色菜单

POST /shop/api/sys/grant/role_menu
参数
类型 名称 说明 类型

Body

dto
必填

dto

授权请求
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/grant/role_menu
请求 body
{
  "grantIds" : [ "string" ],
  "halfPermissions" : [ "string" ],
  "permissions" : [ "string" ]
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.13. 授权用户角色

POST /shop/api/sys/grant/user_roles
参数
类型 名称 说明 类型

Body

dto
必填

dto

授权请求
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/grant/user_roles
请求 body
{
  "grantIds" : [ "string" ],
  "halfPermissions" : [ "string" ],
  "permissions" : [ "string" ]
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.14. 系统菜单权限列表

GET /shop/api/sys/menu/authorities/{menuId}
参数
类型 名称 说明 类型

Path

menuId
必填

menuId

string
响应
HTTP代码 说明 类型

200

OK

< string > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/menu/authorities/string
HTTP响应示例
响应 200
[ "string" ]

4.4.15. 系统菜单详情

GET /shop/api/sys/menu/detail/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

系统菜单列表
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/menu/detail/string
HTTP响应示例
响应 200
{
  "alwaysShow" : false,
  "byOrder" : 0,
  "component" : "string",
  "createdTime" : "string",
  "hidden" : false,
  "id" : "string",
  "lastModifiedTime" : "string",
  "meta" : "string",
  "parentId" : "string",
  "path" : "string",
  "redirect" : "string",
  "remark" : "string"
}

4.4.16. 系统菜单列表

POST /shop/api/sys/menu/list
参数
类型 名称 说明 类型

Query

params
必填

params

object
响应
HTTP代码 说明 类型

200

OK

< 菜单 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/menu/list
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
[ {
  "byOrder" : 0,
  "children" : [ {
    "byOrder" : 0,
    "children" : [ "..." ],
    "disabled" : true,
    "icon" : "string",
    "id" : "string",
    "label" : "string",
    "leaf" : false
  } ],
  "disabled" : true,
  "icon" : "string",
  "id" : "string",
  "label" : "string",
  "leaf" : false
} ]

4.4.17. 系统菜单移除

DELETE /shop/api/sys/menu/remove/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/menu/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.18. 系统菜单添加

POST /shop/api/sys/menu/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

系统菜单列表
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/menu/save
请求 body
{
  "alwaysShow" : false,
  "byOrder" : 0,
  "component" : "string",
  "createdTime" : "string",
  "hidden" : false,
  "id" : "string",
  "lastModifiedTime" : "string",
  "meta" : "string",
  "parentId" : "string",
  "path" : "string",
  "redirect" : "string",
  "remark" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.19. 系统菜单树形列表

POST /shop/api/sys/menu/tree_list
参数
类型 名称 说明 类型

Query

parentId
必填

parentId

string
响应
HTTP代码 说明 类型

200

OK

< 菜单 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/menu/tree_list
请求 query
{
  "parentId" : "string"
}
HTTP响应示例
响应 200
[ {
  "byOrder" : 0,
  "children" : [ {
    "byOrder" : 0,
    "children" : [ "..." ],
    "disabled" : true,
    "icon" : "string",
    "id" : "string",
    "label" : "string",
    "leaf" : false
  } ],
  "disabled" : true,
  "icon" : "string",
  "id" : "string",
  "label" : "string",
  "leaf" : false
} ]

4.4.20. 系统角色权限列表

GET /shop/api/sys/role/authorities/{roleId}
参数
类型 名称 说明 类型

Path

roleId
必填

roleId

string
响应
HTTP代码 说明 类型

200

OK

< string > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/role/authorities/string
HTTP响应示例
响应 200
[ "string" ]

4.4.21. 系统角色列表

POST /shop/api/sys/role/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/role/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.4.22. 系统角色菜单列表

GET /shop/api/sys/role/menu/{roleId}
参数
类型 名称 说明 类型

Path

roleId
必填

roleId

string
响应
HTTP代码 说明 类型

200

OK

< string > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/role/menu/string
HTTP响应示例
响应 200
[ "string" ]

4.4.23. 系统角色移除

DELETE /shop/api/sys/role/remove/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/role/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.24. 系统角色添加

POST /shop/api/sys/role/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

系统角色信息
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/role/save
请求 body
{
  "createdTime" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "remark" : "string",
  "roleCode" : "string",
  "roleName" : "string",
  "status" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.25. 类别选择

POST /shop/api/sys/select/{selectType}
参数
类型 名称 说明 类型

Path

selectType
必填

selectType

enum (SYS_USER, ROLE, JOB_TRIGGER, MENU_PATH, APP_NO, MA_TYPE)

Query

params
可选

params

object
响应
HTTP代码 说明 类型

200

OK

< 选择器 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/select/string
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
[ {
  "children" : [ {
    "children" : [ "..." ],
    "disabled" : false,
    "label" : "string",
    "value" : "string"
  } ],
  "disabled" : false,
  "label" : "string",
  "value" : "string"
} ]

4.4.26. 类别选择

POST /shop/api/sys/selects/{selectTypes}
参数
类型 名称 说明 类型

Path

selectTypes
必填

selectTypes

string

Query

params
可选

params

object
响应
HTTP代码 说明 类型

200

OK

< string, < 选择器 > array > map
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/selects/string
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
"object"

4.4.27. 添加增量权限

POST /shop/api/sys/sync/authorities
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/sync/authorities
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.28. 唯一值检测

POST /shop/api/sys/unique/{selectType}
参数
类型 名称 说明 类型

Path

selectType
必填

selectType

enum (SYS_USER, ROLE, JOB_TRIGGER, MENU_PATH, APP_NO, MA_TYPE)

Query

params
可选

params

object
响应
HTTP代码 说明 类型

200

OK

integer (int64)
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/unique/string
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
0

4.4.29. 系统用户列表

POST /shop/api/sys/user/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/user/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.4.30. 系统用户移除

DELETE /shop/api/sys/user/remove/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/user/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.31. 系统用户添加

POST /shop/api/sys/user/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

系统用户信息
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/user/save
请求 body
{
  "active" : false,
  "avatar" : "string",
  "createdTime" : "string",
  "email" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "phoneNo" : "string",
  "pwd" : "string",
  "realName" : "string",
  "remark" : "string",
  "roleCodeViews" : "string",
  "roleCodes" : [ "string" ],
  "roleNameViews" : "string",
  "roleNames" : [ "string" ],
  "username" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.4.32. 系统用户激活|锁定

PUT /shop/api/sys/user/status/{id}/{active}
参数
类型 名称 说明 类型

Path

active
必填

active

boolean

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/user/status/string/true
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.5. 应用相关

App Brand Mgt Controller

4.5.1. 应用品牌详情

GET /shop/api/app_brand/brand/details/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

应用品牌
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app_brand/brand/details/string
HTTP响应示例
响应 200
{
  "appDesc" : "string",
  "appName" : "string",
  "appNo" : "string",
  "createdTime" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "logo" : "string",
  "maConfigs" : [ {
    "aesKey" : "string",
    "aid" : "string",
    "appId" : "string",
    "appKey" : "string",
    "appNo" : "string",
    "createdTime" : "string",
    "id" : "string",
    "lastModifiedTime" : "string",
    "maType" : "string",
    "msgDataFormat" : "string",
    "remark" : "string",
    "secret" : "string",
    "token" : "string"
  } ],
  "remark" : "string"
}

4.5.2. 应用品牌列表

POST /shop/api/app_brand/brand/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app_brand/brand/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.5.3. 应用品牌详情

GET /shop/api/app_brand/brand/ma_config/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

< 应用小程序配置 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app_brand/brand/ma_config/string
HTTP响应示例
响应 200
[ {
  "aesKey" : "string",
  "aid" : "string",
  "appId" : "string",
  "appKey" : "string",
  "appNo" : "string",
  "createdTime" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "maType" : "string",
  "msgDataFormat" : "string",
  "remark" : "string",
  "secret" : "string",
  "token" : "string"
} ]

4.5.4. 应用品牌删除

DELETE /shop/api/app_brand/brand/remove/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app_brand/brand/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.5.5. 应用品牌添加

POST /shop/api/app_brand/brand/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

应用品牌
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app_brand/brand/save
请求 body
{
  "appDesc" : "string",
  "appName" : "string",
  "appNo" : "string",
  "createdTime" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "logo" : "string",
  "maConfigs" : [ {
    "aesKey" : "string",
    "aid" : "string",
    "appId" : "string",
    "appKey" : "string",
    "appNo" : "string",
    "createdTime" : "string",
    "id" : "string",
    "lastModifiedTime" : "string",
    "maType" : "string",
    "msgDataFormat" : "string",
    "remark" : "string",
    "secret" : "string",
    "token" : "string"
  } ],
  "remark" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.5.6. 应用小程序配置删除

DELETE /shop/api/app_brand/ma_config/remove/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app_brand/ma_config/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.5.7. 小程序配置添加

POST /shop/api/app_brand/ma_config/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

应用小程序配置
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app_brand/ma_config/save
请求 body
{
  "aesKey" : "string",
  "aid" : "string",
  "appId" : "string",
  "appKey" : "string",
  "appNo" : "string",
  "createdTime" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "maType" : "string",
  "msgDataFormat" : "string",
  "remark" : "string",
  "secret" : "string",
  "token" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.6. 应用配置

App Brand Controller

4.6.1. 获取小程序配置

GET /shop/api/app/insecure/ma_config/{appNo}/{maType}
参数
类型 名称 说明 类型

Path

appNo
必填

appNo

string

Path

maType
必填

maType

enum (wx, swan, my, tt, h5, web)
响应
HTTP代码 说明 类型

200

OK

小程序配置
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app/insecure/ma_config/string/string
HTTP响应示例
响应 200
{
  "appId" : "string",
  "appKey" : "string",
  "appNo" : "string"
}

4.7. 微信小程序

Ma User Controller

4.7.1. 获取用户绑定手机号

GET /shop/api/app/ma/{appNo}/{maType}/phone
参数
类型 名称 说明 类型

Path

appNo
必填

应用编号

string

Path

maType
必填

maType

enum (wx, swan, my, tt, h5, web)

Body

dto
必填

dto

小程序手机信息
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app/ma/string/string/phone
请求 body
{
  "encryptedData" : "string",
  "iv" : "string",
  "openid" : "string",
  "rawData" : "string",
  "signature" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.7.2. 保存登录用户信息

POST /shop/api/app/ma/{appNo}/{maType}/user
参数
类型 名称 说明 类型

Path

appNo
必填

应用编号

string

Path

maType
必填

maType

enum (wx, swan, my, tt, h5, web)

Body

dto
必填

dto

小程序用户信息
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app/ma/string/string/user
请求 body
{
  "encryptedData" : "string",
  "iv" : "string",
  "openid" : "string",
  "rawData" : "string",
  "signature" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.7.3. POST方式微信认证

POST /shop/api/app/portal/ma/{appNo}
参数
类型 名称 说明 类型

Path

appNo
必填

应用编号

string

Query

encrypt_type
必填

encrypt_type

string

Query

msg_signature
必填

msg_signature

string

Query

nonce
必填

nonce

string

Query

signature
必填

signature

string

Query

timestamp
必填

timestamp

string

Body

requestBody
必填

requestBody

string
响应
HTTP代码 说明 类型

200

OK

string
消耗

  • application/json

生成

  • application/xml;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app/portal/ma/string
请求 query
{
  "encrypt_type" : "string",
  "msg_signature" : "string",
  "nonce" : "string",
  "signature" : "string",
  "timestamp" : "string"
}
请求 body
{ }
HTTP响应示例
响应 200
"string"

4.7.4. GET方式微信认证

GET /shop/api/app/portal/ma/{appNo}
参数
类型 名称 说明 类型

Path

appNo
必填

应用编号

string

Query

echostr
可选

echostr

string

Query

nonce
可选

nonce

string

Query

signature
可选

signature

string

Query

timestamp
可选

timestamp

string
响应
HTTP代码 说明 类型

200

OK

string
消耗

  • application/json

生成

  • text/plain;charset=utf-8

HTTP请求示例
请求 path
/shop/api/app/portal/ma/string
请求 query
{
  "echostr" : "string",
  "nonce" : "string",
  "signature" : "string",
  "timestamp" : "string"
}
HTTP响应示例
响应 200
"string"

4.8. 数据字典

Sys Metadata Controller

4.8.1. 表结构

GET /shop/api/sys/metadata/details/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

数据字典表
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/metadata/details/string
HTTP响应示例
响应 200
{
  "columns" : [ {
    "columnName" : "string",
    "columnSize" : 0,
    "decimalDigits" : 0,
    "id" : "string",
    "notNull" : false,
    "remarks" : "string",
    "tableId" : "string",
    "typeName" : "string"
  } ],
  "id" : "string",
  "pkName" : "string",
  "remarks" : "string",
  "tableName" : "string",
  "tableScheme" : "string",
  "tableType" : "string"
}

4.8.2. 同步表结构

POST /shop/api/sys/metadata/sync
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/metadata/sync
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.8.3. 列表

POST /shop/api/sys/metadata/table/all_list
参数
类型 名称 说明 类型

Query

params
必填

params

object
响应
HTTP代码 说明 类型

200

OK

< 数据字典表 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/metadata/table/all_list
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
[ {
  "columns" : [ {
    "columnName" : "string",
    "columnSize" : 0,
    "decimalDigits" : 0,
    "id" : "string",
    "notNull" : false,
    "remarks" : "string",
    "tableId" : "string",
    "typeName" : "string"
  } ],
  "id" : "string",
  "pkName" : "string",
  "remarks" : "string",
  "tableName" : "string",
  "tableScheme" : "string",
  "tableType" : "string"
} ]

4.8.4. 列表

POST /shop/api/sys/metadata/table/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/metadata/table/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.9. 用户登录

Ma Auth Controller

4.9.1. 账号登陆

POST /shop/api/app/auth/{appNo}/{maType}/login
参数
类型 名称 说明 类型

Path

appNo
必填

应用编号

string

Path

maType
必填

maType

enum (wx, swan, my, tt, h5, web)

Body

dto
必填

dto

小程序登录
响应
HTTP代码 说明 类型

200

OK

登录响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app/auth/string/string/login
请求 body
{
  "code" : "string",
  "password" : "string",
  "username" : "string"
}
HTTP响应示例
响应 200
{
  "hasUser" : false,
  "token" : "string"
}

4.9.2. 登陆接口

POST /shop/api/app/auth/{appNo}/{maType}/ma_login
参数
类型 名称 说明 类型

Path

appNo
必填

应用编号

string

Path

maType
必填

maType

enum (wx, swan, my, tt, h5, web)

Body

dto
必填

dto

小程序登录
响应
HTTP代码 说明 类型

200

OK

登录响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app/auth/string/string/ma_login
请求 body
{
  "code" : "string",
  "password" : "string",
  "username" : "string"
}
HTTP响应示例
响应 200
{
  "hasUser" : false,
  "token" : "string"
}

4.10. 用户相关

User Mgt Controller

4.10.1. 用户列表

POST /shop/api/user/login/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/user/login/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.10.2. 小程序会话列表

POST /shop/api/user/ma_session/_list
参数
类型 名称 说明 类型

Query

params
必填

params

object
响应
HTTP代码 说明 类型

200

OK

< 小程序会话密钥 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/user/ma_session/_list
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
[ {
  "appNo" : "string",
  "createdTime" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "maType" : "string",
  "openid" : "string",
  "remark" : "string",
  "sessionKey" : "string",
  "uid" : "string"
} ]

4.10.3. 小程序会话分页列表

POST /shop/api/user/ma_session/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/user/ma_session/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.11. 系统任务

Sys Job Controller

4.11.1. 任务列表

POST /shop/api/sys/jobs/details/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/details/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.11.2. 删除任务

DELETE /shop/api/sys/jobs/details/remove/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/details/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.11.3. 任务创建更新

POST /shop/api/sys/jobs/details/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

系统任务
响应
HTTP代码 说明 类型

200

OK

系统任务
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/details/save
请求 body
{
  "clazzPath" : "string",
  "createdTime" : "string",
  "description" : "string",
  "id" : "string",
  "jobName" : "string",
  "jobParams" : "string",
  "lastModifiedTime" : "string",
  "remark" : "string",
  "status" : "string"
}
HTTP响应示例
响应 200
{
  "clazzPath" : "string",
  "createdTime" : "string",
  "description" : "string",
  "id" : "string",
  "jobName" : "string",
  "jobParams" : "string",
  "lastModifiedTime" : "string",
  "remark" : "string",
  "status" : "string"
}

4.11.4. 任务实例列表

POST /shop/api/sys/jobs/instance/list
参数
类型 名称 说明 类型

Query

params
必填

params

object
响应
HTTP代码 说明 类型

200

OK

< 系统任务实例 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/instance/list
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
[ {
  "clazzPath" : "string",
  "createdTime" : "string",
  "endTime" : "string",
  "groupName" : "string",
  "id" : "string",
  "instanceId" : "string",
  "instanceParams" : "string",
  "jobId" : "string",
  "jobName" : "string",
  "lastModifiedTime" : "string",
  "remark" : "string",
  "startTime" : "string",
  "status" : "string",
  "triggerId" : "string",
  "triggerRule" : "string"
} ]

4.11.5. 实例日志列表

POST /shop/api/sys/jobs/instance/logs/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/instance/logs/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.11.6. 实例日志统计

POST /shop/api/sys/jobs/instance/logs/statistics
参数
类型 名称 说明 类型

Query

params
必填

params

object
响应
HTTP代码 说明 类型

200

OK

object
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/instance/logs/statistics
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
"object"

4.11.7. 暂停任务

POST /shop/api/sys/jobs/instance/pause/{instanceId}
参数
类型 名称 说明 类型

Path

instanceId
必填

instanceId

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/instance/pause/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.11.8. 删除任务

POST /shop/api/sys/jobs/instance/remove/{instanceId}
参数
类型 名称 说明 类型

Path

instanceId
必填

instanceId

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/instance/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.11.9. 任务实例创建

POST /shop/api/sys/jobs/instance/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

创建任务实例
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/instance/save
请求 body
{
  "endTime" : "string",
  "groupName" : "string",
  "instanceParams" : {
    "string" : "string"
  },
  "jobId" : "string",
  "onlyError" : true,
  "startTime" : "string",
  "triggerId" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.11.10. 启动任务

POST /shop/api/sys/jobs/instance/start/{instanceId}
参数
类型 名称 说明 类型

Path

instanceId
必填

instanceId

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/instance/start/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.11.11. 任务列表

POST /shop/api/sys/jobs/trigger/list
参数
类型 名称 说明 类型

Query

params
必填

params

object
响应
HTTP代码 说明 类型

200

OK

< 任务触发器 > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/trigger/list
请求 query
{
  "params" : "object"
}
HTTP响应示例
响应 200
[ {
  "createdTime" : "string",
  "cron" : "string",
  "daysOfWeek" : "string",
  "endTimeOfDay" : "string",
  "id" : "string",
  "interval" : 0,
  "intervalUnit" : "string",
  "lastModifiedTime" : "string",
  "remark" : "string",
  "repeatCount" : 0,
  "startTimeOfDay" : "string",
  "triggerName" : "string",
  "triggerType" : "string"
} ]

4.11.12. 删除任务

DELETE /shop/api/sys/jobs/trigger/remove/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/trigger/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.11.13. 任务创建更新

POST /shop/api/sys/jobs/trigger/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

任务触发器
响应
HTTP代码 说明 类型

200

OK

任务触发器
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/jobs/trigger/save
请求 body
{
  "createdTime" : "string",
  "cron" : "string",
  "daysOfWeek" : "string",
  "endTimeOfDay" : "string",
  "id" : "string",
  "interval" : 0,
  "intervalUnit" : "string",
  "lastModifiedTime" : "string",
  "remark" : "string",
  "repeatCount" : 0,
  "startTimeOfDay" : "string",
  "triggerName" : "string",
  "triggerType" : "string"
}
HTTP响应示例
响应 200
{
  "createdTime" : "string",
  "cron" : "string",
  "daysOfWeek" : "string",
  "endTimeOfDay" : "string",
  "id" : "string",
  "interval" : 0,
  "intervalUnit" : "string",
  "lastModifiedTime" : "string",
  "remark" : "string",
  "repeatCount" : 0,
  "startTimeOfDay" : "string",
  "triggerName" : "string",
  "triggerType" : "string"
}

4.12. 系统操作日志

Sys Opt Log Controller

4.12.1. 操作日志

POST /shop/api/sys/opt_log/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/opt_log/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.13. 系统（管理）

Login Mgt Controller

4.13.1. msgList

GET /shop/api/app/msg_list
响应
HTTP代码 说明 类型

200

OK

< string > array
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app/msg_list
HTTP响应示例
响应 200
[ "string" ]

4.13.2. 获取登录用户信息

GET /shop/api/app/user_info
响应
HTTP代码 说明 类型

200

OK

用户登录信息
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/app/user_info
HTTP响应示例
响应 200
{
  "appNo" : "string",
  "avatarUrl" : "string",
  "city" : "string",
  "country" : "string",
  "createdTime" : "string",
  "gender" : 0,
  "id" : "string",
  "lastModifiedTime" : "string",
  "maType" : "string",
  "nickName" : "string",
  "openid" : "string",
  "password" : "string",
  "phoneNo" : "string",
  "province" : "string",
  "remark" : "string",
  "unionid" : "string",
  "username" : "string"
}

4.13.3. 系统用户登录

POST /shop/api/login/auth
参数
类型 名称 说明 类型

Body

dto
必填

dto

管理登录
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/login/auth
请求 body
{
  "password" : "string",
  "username" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.13.4. 用户注销

POST /shop/api/login/logout
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/login/logout
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.13.5. 码值

GET /shop/api/sys/code/cache
参数
类型 名称 说明 类型

Query

typeCode
必填

typeCode

string
响应
HTTP代码 说明 类型

200

OK

object
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/code/cache
请求 query
{
  "typeCode" : "string"
}
HTTP响应示例
响应 200
"object"

4.13.6. 码值2

POST /shop/api/sys/code/caches
参数
类型 名称 说明 类型

Query

typeCodes
必填

typeCodes

string
响应
HTTP代码 说明 类型

200

OK

object
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/code/caches
请求 query
{
  "typeCodes" : "string"
}
HTTP响应示例
响应 200
"object"

4.13.7. 码值列表

POST /shop/api/sys/code/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/code/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.13.8. 码值移除

DELETE /shop/api/sys/code/remove/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/code/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.13.9. 码值添加

POST /shop/api/sys/code/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

字典信息
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/code/save
请求 body
{
  "createdTime" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "remark" : "string",
  "status" : "string",
  "typeCode" : "string",
  "valCode" : "string",
  "valName" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.13.10. 获取类型下一个序列值

GET /shop/api/sys/code/type/last_code
响应
HTTP代码 说明 类型

200

OK

单值响应对象
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/code/type/last_code
HTTP响应示例
响应 200
{
  "value" : "object"
}

4.13.11. 码类列表

POST /shop/api/sys/code/type/list
参数
类型 名称 说明 类型

Query

list
可选

结果集

< object > array(multi)

Query

orderBy
可选

排序

string

Query

pageNum
可选

当前页

integer (int32)

Query

pageSize
可选

每页的数量

integer (int32)

Query

pages
可选

总页数

integer (int32)

Query

params
可选

查询条件

object

Query

size
可选

当前页的数量

integer (int32)

Query

total
可选

总数量

integer (int64)
响应
HTTP代码 说明 类型

200

OK

分页对象Ofobject
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/code/type/list
请求 query
{
  "list" : "object",
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}
HTTP响应示例
响应 200
{
  "list" : [ "object" ],
  "orderBy" : "string",
  "pageNum" : 0,
  "pageSize" : 0,
  "pages" : 0,
  "params" : "object",
  "size" : 0,
  "total" : 0
}

4.13.12. 码类移除

DELETE /shop/api/sys/code/type/remove/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/code/type/remove/string
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.13.13. 码类添加

POST /shop/api/sys/code/type/save
参数
类型 名称 说明 类型

Body

dto
必填

dto

字典类型
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/code/type/save
请求 body
{
  "createdTime" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "remark" : "string",
  "status" : "string",
  "typeCode" : "string",
  "typeName" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.13.14. 获取下一个序列值

GET /shop/api/sys/code/{typeCode}/last_code
参数
类型 名称 说明 类型

Path

typeCode
必填

typeCode

string
响应
HTTP代码 说明 类型

200

OK

单值响应对象
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/code/string/last_code
HTTP响应示例
响应 200
{
  "value" : "object"
}

4.13.15. 用户重置密码

POST /shop/api/sys/reset_password
参数
类型 名称 说明 类型

Body

dto
必填

dto

重置密码
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/reset_password
请求 body
{
  "currentPassword" : "string",
  "originalPassword" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.13.16. 更新用户信息

POST /shop/api/sys/update/user_detail
参数
类型 名称 说明 类型

Body

dto
必填

dto

系统用户
响应
HTTP代码 说明 类型

200

OK

全局响应
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/update/user_detail
请求 body
{
  "active" : false,
  "avatar" : "string",
  "createdTime" : "string",
  "email" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "password" : "string",
  "phoneNo" : "string",
  "realName" : "string",
  "remark" : "string",
  "username" : "string"
}
HTTP响应示例
响应 200
{
  "errorCode" : 0,
  "message" : "请求成功"
}

4.13.17. 获取用户信息

GET /shop/api/sys/user_detail
响应
HTTP代码 说明 类型

200

OK

系统用户
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/user_detail
HTTP响应示例
响应 200
{
  "active" : false,
  "avatar" : "string",
  "createdTime" : "string",
  "email" : "string",
  "id" : "string",
  "lastModifiedTime" : "string",
  "password" : "string",
  "phoneNo" : "string",
  "realName" : "string",
  "remark" : "string",
  "username" : "string"
}

4.13.18. 获取用户登录信息

GET /shop/api/sys/user_info
响应
HTTP代码 说明 类型

200

OK

object
消耗

  • application/json

生成

  • application/json;charset=UTF-8

HTTP请求示例
请求 path
/shop/api/sys/user_info
HTTP响应示例
响应 200
"object"

5. 定义

5.1. 任务触发器

名称 说明 类型

createdTime
可选

创建时间
样例 : "string"

string (date-time)

cron
可选

Cron
样例 : "string"

string

daysOfWeek
可选

需要执行的星期
样例 : "string"

string

endTimeOfDay
可选

每天结束时间
样例 : "string"

string

id
可选

ID
样例 : "string"

string

interval
可选

间隔
样例 : 0

integer (int32)

intervalUnit
可选

间隔单位
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

remark
可选

备注（修改记录)
样例 : "string"

string

repeatCount
可选

重复次数
样例 : 0

integer (int32)

startTimeOfDay
可选

每天开始时间
样例 : "string"

string

triggerName
必填

触发器名称
样例 : "string"

string

triggerType
必填

触发类型(1002)
样例 : "string"

string

5.2. 全局响应

名称 说明 类型

errorCode
必填

返回码
样例 : 0

integer (int32)

message
可选

说明
样例 : "请求成功"

string

5.3. 分页对象Ofobject

名称 说明 类型

list
可选

结果集
样例 : [ "object" ]

< object > array

orderBy
可选

排序
样例 : "string"

string

pageNum
可选

当前页
样例 : 0

integer (int32)

pageSize
可选

每页的数量
样例 : 0

integer (int32)

pages
可选

总页数
样例 : 0

integer (int32)

params
可选

查询条件
样例 : "object"

object

size
可选

当前页的数量
样例 : 0

integer (int32)

total
可选

总数量
样例 : 0

integer (int64)

5.4. 创建任务实例

名称 说明 类型

endTime
可选

结束时间
样例 : "string"

string (date-time)

groupName
可选

组名称
样例 : "string"

string

instanceParams
可选

任务实例参数
样例 : {
"string" : "string"
}

< string, string > map

jobId
必填

任务ID
样例 : "string"

string

onlyError
可选

样例 : true

boolean

startTime
可选

开始时间
样例 : "string"

string (date-time)

triggerId
必填

触发器ID
样例 : "string"

string

5.5. 单值响应对象

名称 说明 类型

value
可选

样例 : "object"

object

5.6. 地区数据

名称 说明 类型

depth
必填

级别
样例 : 0

integer (int32)

depthName
可选

级别名称
样例 : "string"

string

firstLetter
可选

首字符
样例 : "string"

string

id
可选

ID
样例 : "string"

string

jianPin
可选

简拼
样例 : "string"

string

name
必填

名称
样例 : "string"

string

parentId
可选

父级ID
样例 : "string"

string

pinYin
可选

拼音
样例 : "string"

string

5.7. 字典信息

名称 说明 类型

createdTime
可选

创建时间
样例 : "string"

string (date-time)

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

remark
可选

备注（修改记录)
样例 : "string"

string

status
必填

是否启用（码类：1000）
样例 : "string"

string

typeCode
必填

码类编码
样例 : "string"

string

valCode
必填

码值编码
样例 : "string"

string

valName
必填

码值名称
样例 : "string"

string

5.8. 字典类型

名称 说明 类型

createdTime
可选

创建时间
样例 : "string"

string (date-time)

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

remark
可选

备注（修改记录)
样例 : "string"

string

status
必填

是否启用（码类：1000）
样例 : "string"

string

typeCode
必填

码类编码(唯一)
样例 : "string"

string

typeName
必填

码类名称
样例 : "string"

string

5.9. 小程序会话密钥

名称 说明 类型

appNo
必填

应用编号
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string (date-time)

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

maType
必填

小程序类型(wx|swan|my|tt)
样例 : "string"

string

openid
必填

小程序openid
样例 : "string"

string

remark
可选

备注（修改记录)
样例 : "string"

string

sessionKey
可选

会话密钥
样例 : "string"

string

uid
可选

用户ID
样例 : "string"

string

5.10. 小程序手机信息

名称 说明 类型

encryptedData
必填

加密数据
样例 : "string"

string

iv
必填

加密算法的初始向量
样例 : "string"

string

openid
必填

openid
样例 : "string"

string

rawData
必填

用户信息
样例 : "string"

string

signature
必填

签名
样例 : "string"

string

5.11. 小程序用户信息

名称 说明 类型

encryptedData
必填

加密数据
样例 : "string"

string

iv
必填

加密算法的初始向量
样例 : "string"

string

openid
必填

openid
样例 : "string"

string

rawData
必填

用户信息
样例 : "string"

string

signature
必填

签名
样例 : "string"

string

5.12. 小程序登录

名称 说明 类型

code
必填

code
样例 : "string"

string

password
可选

密码|验证码
样例 : "string"

string

username
可选

用户名|手机号
样例 : "string"

string

5.13. 小程序配置

名称 说明 类型

appId
必填

小程序的appid
样例 : "string"

string

appKey
可选

小程序的appKey
样例 : "string"

string

appNo
必填

应用编号
样例 : "string"

string

5.14. 应用品牌

名称 说明 类型

appDesc
可选

应用描述
样例 : "string"

string

appName
必填

应用名称
样例 : "string"

string

appNo
必填

应用编号
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string (date-time)

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

logo
可选

Logo
样例 : "string"

string

maConfigs
可选

样例 : [ "应用小程序配置" ]

< 应用小程序配置 > array

remark
可选

备注（修改记录)
样例 : "string"

string

5.15. 应用小程序配置

名称 说明 类型

aesKey
可选

小程序的AESKey
样例 : "string"

string

aid
必填

应用ID
样例 : "string"

string

appId
必填

小程序的appid
样例 : "string"

string

appKey
可选

小程序的appKey
样例 : "string"

string

appNo
必填

应用编号
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string (date-time)

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

maType
必填

小程序类型(wx|swan|my|tt)
样例 : "string"

string

msgDataFormat
可选

消息格式，XML或者JSON
样例 : "string"

string

remark
可选

备注（修改记录)
样例 : "string"

string

secret
必填

小程序的secret
样例 : "string"

string

token
可选

小程序的token
样例 : "string"

string

5.16. 授权请求

名称 说明 类型

grantIds
必填

授权对象ID（用户ID|角色ID）
样例 : [ "string" ]

< string > array

halfPermissions
可选

授权权限(半选)
样例 : [ "string" ]

< string > array

permissions
必填

授权权限
样例 : [ "string" ]

< string > array

5.17. 数据字典列

名称 说明 类型

columnName
必填

列名
样例 : "string"

string

columnSize
可选

长度
样例 : 0

integer (int32)

decimalDigits
可选

小数保留位
样例 : 0

integer (int32)

id
可选

ID
样例 : "string"

string

notNull
可选

是否为空
样例 : false

boolean

remarks
可选

注释
样例 : "string"

string

tableId
必填

字典表ID
样例 : "string"

string

typeName
必填

类型
样例 : "string"

string

5.18. 数据字典表

名称 说明 类型

columns
可选

样例 : [ "数据字典列" ]

< 数据字典列 > array

id
可选

ID
样例 : "string"

string

pkName
可选

主键
样例 : "string"

string

remarks
可选

注释
样例 : "string"

string

tableName
必填

表名
样例 : "string"

string

tableScheme
可选

Scheme
样例 : "string"

string

tableType
可选

表类型
样例 : "string"

string

5.19. 权限

名称 说明 类型

byOrder
可选

排序
样例 : "string"

string

children
可选

样例 : [ "权限" ]

< 权限 > array

disabled
可选

样例 : true

boolean

id
必填

ID
样例 : "string"

string

label
必填

Label
样例 : "string"

string

5.20. 用户登录信息

名称 说明 类型

appNo
必填

应用编号
样例 : "string"

string

avatarUrl
可选

头像
样例 : "string"

string

city
可选

城市
样例 : "string"

string

country
可选

国家
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string (date-time)

gender
可选

性别表示：0,1,2等数字.
样例 : 0

integer (int32)

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

maType
可选

小程序类型(wx|swan|my|tt|h5)
样例 : "string"

string

nickName
可选

昵称（用于显示）
样例 : "string"

string

openid
可选

小程序openid
样例 : "string"

string

password
可选

用户密码
样例 : "string"

string

phoneNo
可选

手机号（h5模式）
样例 : "string"

string

province
可选

省
样例 : "string"

string

remark
可选

备注（修改记录)
样例 : "string"

string

unionid
可选

(小程序用户 + 主体维度)id
样例 : "string"

string

username
可选

用户名
样例 : "string"

string

5.21. 登录响应

名称 说明 类型

hasUser
必填

已注册
样例 : false

boolean

token
必填

Token
样例 : "string"

string

5.22. 管理登录

名称 说明 类型

password
必填

密码
样例 : "string"

string

username
必填

用户名
样例 : "string"

string

5.23. 系统API列表

名称 说明 类型

apiName
必填

API名称
样例 : "string"

string

apiTag
可选

API tag
样例 : "string"

string

apiUrl
必填

APIUrl
样例 : "string"

string

byOrder
可选

排序
样例 : 0

integer (int32)

createdTime
可选

创建时间
样例 : "string"

string (date-time)

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

parentId
可选

父节点ID
样例 : "string"

string

remark
可选

备注（修改记录)
样例 : "string"

string

shiroCode
可选

Shiro编码
样例 : "string"

string

5.24. 系统API权限

名称 说明 类型

action
可选

动作
样例 : "string"

string

authorityName
必填

权限名称
样例 : "string"

string

byOrder
可选

排序
样例 : 0

integer (int32)

createdTime
可选

创建时间
样例 : "string"

string (date-time)

domain
可选

业务
样例 : "string"

string

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

module
必填

权限模块
样例 : "string"

string

parentId
可选

父节点ID
样例 : "string"

string

remark
可选

备注（修改记录)
样例 : "string"

string

5.25. 系统任务

名称 说明 类型

clazzPath
必填

任务执行方法
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string (date-time)

description
可选

任务描述
样例 : "string"

string

id
可选

ID
样例 : "string"

string

jobName
必填

任务名称
样例 : "string"

string

jobParams
可选

任务参数
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

remark
可选

备注（修改记录)
样例 : "string"

string

status
必填

是否启用(1000)
样例 : "string"

string

5.26. 系统任务实例

名称 说明 类型

clazzPath
可选

任务执行方法
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string (date-time)

endTime
可选

结束时间
样例 : "string"

string (date-time)

groupName
可选

组名称
样例 : "string"

string

id
可选

ID
样例 : "string"

string

instanceId
必填

任务实例ID
样例 : "string"

string

instanceParams
可选

任务实例参数
样例 : "string"

string

jobId
必填

任务ID
样例 : "string"

string

jobName
可选

任务名称
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

remark
可选

备注（修改记录)
样例 : "string"

string

startTime
可选

开始时间
样例 : "string"

string (date-time)

status
必填

实例状态(1003)
样例 : "string"

string

triggerId
必填

触发器ID
样例 : "string"

string

triggerRule
可选

触发规则
样例 : "string"

string

5.27. 系统在线用户

名称 说明 类型

host
可选

样例 : "string"

string

id
可选

样例 : "string"

string

lastAccessTime
可选

样例 : "string"

string (date-time)

startTimestamp
可选

样例 : "string"

string (date-time)

status
可选

样例 : "string"

string

systemHost
可选

样例 : "string"

string

timeout
可选

样例 : 0

integer (int64)

userId
可选

样例 : "string"

string

username
可选

样例 : "string"

string

5.28. 系统用户

名称 说明 类型

active
必填

是否激活
样例 : false

boolean

avatar
可选

用户头像
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string (date-time)

email
可选

邮箱
样例 : "string"

string

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

password
可选

用户密码
样例 : "string"

string

phoneNo
可选

手机号
样例 : "string"

string

realName
可选

真实姓名
样例 : "string"

string

remark
可选

备注（修改记录)
样例 : "string"

string

username
必填

用户名(唯一)
样例 : "string"

string

5.29. 系统用户信息

名称 说明 类型

active
必填

是否激活
样例 : false

boolean

avatar
可选

用户头像
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string (date-time)

email
可选

邮箱
样例 : "string"

string

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

phoneNo
可选

手机号
样例 : "string"

string

pwd
可选

编辑密码
样例 : "string"

string

realName
可选

真实姓名
样例 : "string"

string

remark
可选

备注（修改记录)
样例 : "string"

string

roleCodeViews
可选

角色编码显示
样例 : "string"

string

roleCodes
可选

角色编码
样例 : [ "string" ]

< string > array

roleNameViews
可选

角色名称显示
样例 : "string"

string

roleNames
可选

角色名称
样例 : [ "string" ]

< string > array

username
必填

用户名(唯一)
样例 : "string"

string

5.30. 系统菜单列表

名称 说明 类型

alwaysShow
可选

始终显示
样例 : false

boolean

byOrder
可选

排序
样例 : 0

integer (int32)

component
必填

组件名称
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string (date-time)

hidden
可选

是否隐藏
样例 : false

boolean

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

meta
可选

Meta
样例 : "string"

string

parentId
可选

父节点ID
样例 : "string"

string

path
可选

菜单路径
样例 : "string"

string

redirect
可选

redirect
样例 : "string"

string

remark
可选

备注（修改记录)
样例 : "string"

string

5.31. 系统角色信息

名称 说明 类型

createdTime
可选

创建时间
样例 : "string"

string (date-time)

id
可选

ID
样例 : "string"

string

lastModifiedTime
可选

最后修改时间
样例 : "string"

string (date-time)

remark
可选

备注（修改记录)
样例 : "string"

string

roleCode
必填

角色编码(唯一)
样例 : "string"

string

roleName
必填

角色名称
样例 : "string"

string

status
必填

是否启用（码类：1000）
样例 : "string"

string

5.32. 菜单

名称 说明 类型

byOrder
可选

排序
样例 : 0

integer (int32)

children
可选

样例 : [ "菜单" ]

< 菜单 > array

disabled
可选

样例 : true

boolean

icon
必填

Icon
样例 : "string"

string

id
必填

ID
样例 : "string"

string

label
必填

Label
样例 : "string"

string

leaf
可选

是否叶节点
样例 : false

boolean

5.33. 选择器

名称 说明 类型

children
必填

Children
样例 : [ "选择器" ]

< 选择器 > array

disabled
必填

Disabled
样例 : false

boolean

label
必填

Label
样例 : "string"

string

value
必填

Value
样例 : "string"

string

5.34. 重置密码

名称 说明 类型

currentPassword
必填

当前密码
样例 : "string"

string

originalPassword
必填

原密码
样例 : "string"

string