捕梦者基础框架API接口
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

2845 lines
116 KiB

{
"openapi": "3.0.0",
"info": {
"title": "这是我的swagger文档第一个Api",
"description": "用户Api接口",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"name": "安徽云掌技术支持",
"url": "http://www.ahbmz.com",
"email": "txg@huamill.com"
},
"license": {
"name": "BMZMIT"
},
"version": "1.0.0"
},
"servers": [
{
"url": "base.ahbmz.com",
"description": "API server"
}
],
"paths": {
"config/index": {
"get": {
"tags": [
"系统配置"
],
"summary": "获取系统配置",
"description": "获取系统配置",
"operationId": "app\\api\\controller\\Config::index",
"parameters": [
{
"$ref": "#/components/parameters/token"
},
{
"name": "name",
"in": "query",
"description": "配置名称",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "配置标识",
"schema": {
"type": "string"
}
},
{
"name": "value",
"in": "query",
"description": "配置值",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "返回所有配置信息"
}
}
}
},
"config/save": {
"post": {
"tags": [
"系统配置"
],
"summary": "系统配置",
"description": "系统配置",
"operationId": "app\\api\\controller\\Config::save",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"name": {
"description": "此那么可自行定义 比如 seo_title",
"type": "string"
},
"value": {
"description": "此那么可自行定义 比如 合肥网站优化",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "添加成功",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录总数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "添加成功的的数据ID",
"type": "integer",
"format": "int32"
}
},
"type": "object"
}
}
}
}
}
}
},
"demo/index": {
"get": {
"tags": [
"测试案例"
],
"summary": "获取DEMO列表",
"description": "根据相关参数获取DEMO列表",
"operationId": "app\\api\\controller\\Demo::index",
"parameters": [
{
"$ref": "#/components/parameters/token"
},
{
"name": "username",
"in": "query",
"description": "用户名称",
"schema": {
"type": "string"
}
},
{
"name": "sex",
"in": "query",
"description": "用户年龄",
"schema": {
"type": "integer",
"format": "int15"
}
},
{
"name": "page",
"in": "query",
"description": "当前页码",
"schema": {
"type": "integer",
"format": "int15"
}
},
{
"name": "limit",
"in": "query",
"description": "分页数量",
"schema": {
"type": "integer",
"format": "int15"
}
}
],
"responses": {
"200": {
"description": "返回DEMo用户数据信息",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DemoMsgExport"
}
}
}
}
}
}
},
"demo/read/{id}": {
"get": {
"tags": [
"测试案例"
],
"summary": "获取DEMO详情",
"description": "根据ID查询DEMO信息",
"operationId": "app\\api\\controller\\Demo::read",
"parameters": [
{
"$ref": "#/components/parameters/token"
},
{
"name": "id",
"in": "path",
"description": "ID",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "返回DEMO单条用户数据信息",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DemoMsgExport"
}
}
}
}
}
}
},
"demo/add": {
"post": {
"tags": [
"测试案例"
],
"summary": "添加DEMO数据",
"description": "添加后台DEMO管理数据",
"operationId": "app\\api\\controller\\Demo::add",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DemoField"
}
}
}
},
"responses": {
"200": {
"description": "添加成功",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "添加成功的的数据ID",
"type": "integer",
"format": "int32"
}
},
"type": "object"
}
}
}
}
}
}
},
"demo/edit/id/{id}": {
"post": {
"tags": [
"测试案例"
],
"summary": "修改DEMO数据",
"description": "修改后台DEMO管理数据",
"operationId": "app\\api\\controller\\Demo::edit",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DemoField"
}
}
}
},
"responses": {
"200": {
"description": "修改数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"demo/delete": {
"post": {
"tags": [
"测试案例"
],
"summary": "删除DEMO数据",
"description": "根据ID删除DEMO信息",
"operationId": "app\\api\\controller\\Demo::delete",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"id"
],
"properties": {
"id": {
"description": "数据ID或数据ID集合 id=1或 id=1,2,8",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "删除数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"demo/status": {
"post": {
"tags": [
"测试案例"
],
"summary": "更新DEMO状态",
"description": "根据ID及status更新DEMO状态",
"operationId": "app\\api\\controller\\Demo::status",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"id",
"status"
],
"properties": {
"id": {
"description": "数据ID或数据ID集合 id=1或 id=1,2,8",
"type": "string"
},
"status": {
"description": "数据状态 0禁用 1启用",
"type": "integer",
"format": "int15"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "删除数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"group/index": {
"get": {
"tags": [
"角色管理"
],
"summary": "获取角色管理",
"description": "根据相关参数获取角色管理",
"operationId": "app\\api\\controller\\Group::index",
"parameters": [
{
"$ref": "#/components/parameters/token"
},
{
"name": "title",
"in": "query",
"description": "角色名称",
"schema": {
"type": "string"
}
},
{
"name": "role_code",
"in": "query",
"description": "角色标识",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "当前页码",
"schema": {
"type": "integer",
"format": "int15"
}
},
{
"name": "limit",
"in": "query",
"description": "分页数量",
"schema": {
"type": "integer",
"format": "int15"
}
}
],
"responses": {
"200": {
"description": "返回管理员用户数据信息",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupMsgExport"
}
}
}
}
}
}
},
"group/getGroupRule": {
"get": {
"tags": [
"角色管理"
],
"summary": "查询角色权限",
"description": "查询角色所有的权限菜单,并进行标记checked",
"operationId": "app\\api\\controller\\Group::getGroupRule",
"parameters": [
{
"$ref": "#/components/parameters/token"
},
{
"name": "role_id",
"in": "path",
"description": "角色ID",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "返回管理员用户数据信息",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MenuMsgExport"
}
}
}
}
}
}
},
"group/add": {
"post": {
"tags": [
"角色管理"
],
"summary": "添加角色数据",
"description": "添加后台角色数据",
"operationId": "app\\api\\controller\\Group::add",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupField"
}
}
}
},
"responses": {
"200": {
"description": "添加成功",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录总数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "添加成功的的数据ID",
"type": "integer",
"format": "int32"
}
},
"type": "object"
}
}
}
}
}
}
},
"group/addGroupRule/role_id/{role_id}": {
"post": {
"tags": [
"角色管理"
],
"summary": "添加角色权限",
"description": "添加后台角色权限",
"operationId": "app\\api\\controller\\Group::addGroupRule",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"menu_id"
],
"properties": {
"menu_id": {
"description": "数据ID或数据ID集合 id=1或 id=1,2,8",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "添加成功",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录总数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "添加成功的的数据ID",
"type": "integer",
"format": "int32"
}
},
"type": "object"
}
}
}
}
}
}
},
"group/edit/id/{id}": {
"post": {
"tags": [
"角色管理"
],
"summary": "修改角色数据",
"description": "修改角色数据",
"operationId": "app\\api\\controller\\Group::edit",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupField"
}
}
}
},
"responses": {
"200": {
"description": "修改数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"group/status": {
"post": {
"tags": [
"角色管理"
],
"summary": "更新角色状态",
"description": "根据ID及status更新角色状态",
"operationId": "app\\api\\controller\\Group::status",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"id",
"status"
],
"properties": {
"id": {
"description": "数据ID或数据ID集合 id=1或 id=1,2,8",
"type": "string"
},
"status": {
"description": "数据状态 0禁用 1启用",
"type": "integer",
"format": "int15"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "删除数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"group/delete": {
"post": {
"tags": [
"角色管理"
],
"summary": "删除角色数据",
"description": "根据ID删除角色数据",
"operationId": "app\\api\\controller\\Group::delete",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"id"
],
"properties": {
"id": {
"description": "数据ID或数据ID集合 id=1或 id=1,2,8",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "删除数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"log/index": {
"get": {
"tags": [
"日志管理"
],
"summary": "获取日志列表",
"description": "根据相关参数获取日志列表",
"operationId": "app\\api\\controller\\Log::index",
"parameters": [
{
"$ref": "#/components/parameters/token"
},
{
"name": "username",
"in": "query",
"description": "管理员名称",
"schema": {
"type": "string"
}
},
{
"name": "model",
"in": "query",
"description": "操作模块",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "当前页码",
"schema": {
"type": "integer",
"format": "int15"
}
},
{
"name": "limit",
"in": "query",
"description": "分页数量",
"schema": {
"type": "integer",
"format": "int15"
}
}
],
"responses": {
"200": {
"description": "返回管理员用户数据信息",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogMsgExport"
}
}
}
}
}
}
},
"login/login": {
"post": {
"tags": [
"公共分类"
],
"summary": "用户登录",
"description": "用户登录",
"operationId": "app\\api\\controller\\Login::login",
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"username",
"password",
"key",
"code"
],
"properties": {
"username": {
"description": "登录账号",
"type": "string",
"maxLength": 20,
"minLength": 2
},
"password": {
"description": "登录密码",
"type": "string",
"maxLength": 20,
"minLength": 6
},
"key": {
"description": "验证码安全标识 验证码接口返回",
"type": "string",
"maxLength": 100,
"minLength": 1
},
"code": {
"description": "验证码",
"type": "integer",
"format": "int15",
"maxLength": 6,
"minLength": 1
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "返回管理员用户数据信息,token信息、管理员信息"
}
}
}
},
"login/captcha": {
"get": {
"tags": [
"公共分类"
],
"summary": "获取验证码",
"description": "获取验证码",
"operationId": "app\\api\\controller\\Login::captcha",
"responses": {
"200": {
"description": "返回验证码信息",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"manager/index": {
"get": {
"tags": [
"用户管理"
],
"summary": "获取用户列表",
"description": "根据相关参数获取用户列表",
"operationId": "app\\api\\controller\\Manager::index",
"parameters": [
{
"$ref": "#/components/parameters/token"
},
{
"name": "username",
"in": "query",
"description": "管理员名称",
"schema": {
"type": "string"
}
},
{
"name": "truename",
"in": "query",
"description": "真实姓名",
"schema": {
"type": "string"
}
},
{
"name": "phone",
"in": "query",
"description": "手机号",
"schema": {
"type": "integer",
"format": "int15"
}
},
{
"name": "sex",
"in": "query",
"description": "性别",
"schema": {
"type": "integer",
"format": "int15"
}
},
{
"name": "page",
"in": "query",
"description": "当前页码",
"schema": {
"type": "integer",
"format": "int15"
}
},
{
"name": "limit",
"in": "query",
"description": "分页数量",
"schema": {
"type": "integer",
"format": "int15"
}
}
],
"responses": {
"200": {
"description": "返回管理员用户数据信息",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManagerMsgExport"
}
}
}
}
}
}
},
"manager/read/id/{id}": {
"get": {
"tags": [
"用户管理"
],
"summary": "获取用户详情",
"description": "根据ID查询用户信息",
"operationId": "app\\api\\controller\\Manager::read",
"parameters": [
{
"$ref": "#/components/parameters/token"
},
{
"name": "id",
"in": "path",
"description": "ID",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "返回管理员用户数据信息",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManagerMsgExport"
}
}
}
}
}
}
},
"manager/permissMenu": {
"get": {
"tags": [
"用户管理"
],
"summary": "获取用户权限",
"description": "根据当前登录用户UID获取当前用户权限菜单",
"operationId": "app\\api\\controller\\Manager::permissMenu",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"responses": {
"200": {
"description": "返回管理员权限菜单数据",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MenuMsgExport"
}
}
}
}
}
}
},
"manager/add": {
"post": {
"tags": [
"用户管理"
],
"summary": "添加管理员数据",
"description": "添加后台管理员数据",
"operationId": "app\\api\\controller\\Manager::add",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManagerField"
}
}
}
},
"responses": {
"200": {
"description": "添加成功",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录总数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "添加成功的的数据ID",
"type": "integer",
"format": "int32"
}
},
"type": "object"
}
}
}
}
}
}
},
"manager/edit/id/{id}": {
"post": {
"tags": [
"用户管理"
],
"summary": "修改用户数据",
"description": "修改管理员数据",
"operationId": "app\\api\\controller\\Manager::edit",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManagerField"
}
}
}
},
"responses": {
"200": {
"description": "修改数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"manager/passwordEdit": {
"post": {
"tags": [
"用户管理"
],
"summary": "重置用户密码",
"description": "根据ID重置用户密码",
"operationId": "app\\api\\controller\\Manager::passwordEdit",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"id",
"password",
"old_password",
"username"
],
"properties": {
"id": {
"description": "用户ID",
"type": "integer",
"format": "int15"
},
"password": {
"description": "新密码",
"type": "string",
"maxLength": 20,
"minLength": 6
},
"old_password": {
"description": "原始密码",
"type": "string",
"maxLength": 20,
"minLength": 6
},
"username": {
"description": "管理员账号",
"type": "string",
"maxLength": 20,
"minLength": 2
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "删除数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"manager/passwordReset": {
"post": {
"tags": [
"用户管理"
],
"summary": "重置用户密码",
"description": "根据ID重置用户密码",
"operationId": "app\\api\\controller\\Manager::passwordReset",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"id",
"password",
"username"
],
"properties": {
"id": {
"description": "用户ID",
"type": "integer",
"format": "int15"
},
"password": {
"description": "管理员密码",
"type": "string",
"maxLength": 20,
"minLength": 6
},
"username": {
"description": "管理员账号",
"type": "string",
"maxLength": 20,
"minLength": 2
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "删除数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"manager/delete": {
"post": {
"tags": [
"用户管理"
],
"summary": "删除用户数据",
"description": "根据ID删除用户数据",
"operationId": "app\\api\\controller\\Manager::delete",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"id"
],
"properties": {
"id": {
"description": "数据ID或数据ID集合 id=1或 id=1,2,8",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "删除数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"manager/status": {
"post": {
"tags": [
"用户管理"
],
"summary": "更新用户状态",
"description": "根据ID及status更新用户状态",
"operationId": "app\\api\\controller\\Manager::status",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"id",
"status"
],
"properties": {
"id": {
"description": "数据ID或数据ID集合 id=1或 id=1,2,8",
"type": "string"
},
"status": {
"description": "数据状态 0禁用 1启用",
"type": "integer",
"format": "int15"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "删除数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"menu/index": {
"get": {
"tags": [
"权限菜单"
],
"summary": "获取菜单列表",
"description": "根据相关参数获取菜单列表",
"operationId": "app\\api\\controller\\Menu::index",
"parameters": [
{
"$ref": "#/components/parameters/token"
},
{
"name": "path",
"in": "query",
"description": "前端权限路由",
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "权限菜单名称",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "当前页码",
"schema": {
"type": "integer",
"format": "int15"
}
},
{
"name": "limit",
"in": "query",
"description": "分页数量",
"schema": {
"type": "integer",
"format": "int15"
}
}
],
"responses": {
"200": {
"description": "返回权限菜单菜单数据信息",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MenuMsgExport"
}
}
}
}
}
}
},
"menu/add": {
"post": {
"tags": [
"权限菜单"
],
"summary": "添加权限菜单数据",
"description": "添加后台权限菜单数据",
"operationId": "app\\api\\controller\\Menu::add",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MenuField"
}
}
}
},
"responses": {
"200": {
"description": "添加成功",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录总数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "添加成功的的数据ID",
"type": "integer",
"format": "int32"
}
},
"type": "object"
}
}
}
}
}
}
},
"menu/read/id/{id}": {
"get": {
"tags": [
"权限菜单"
],
"summary": "获取菜单详情",
"description": "根据ID查询菜单信息",
"operationId": "app\\api\\controller\\Menu::read",
"parameters": [
{
"$ref": "#/components/parameters/token"
},
{
"name": "id",
"in": "path",
"description": "ID",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "返回权限菜单菜单数据信息",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MenuMsgExport"
}
}
}
}
}
}
},
"menu/edit/id/{id}": {
"post": {
"tags": [
"权限菜单"
],
"summary": "修改菜单数据",
"description": "修改权限菜单数据",
"operationId": "app\\api\\controller\\Menu::edit",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MenuField"
}
}
}
},
"responses": {
"200": {
"description": "修改数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"menu/delete": {
"post": {
"tags": [
"权限菜单"
],
"summary": "删除菜单数据",
"description": "根据ID删除菜单数据",
"operationId": "app\\api\\controller\\Menu::delete",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"id"
],
"properties": {
"id": {
"description": "数据ID或数据ID集合 id=1或 id=1,2,8",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "删除数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"menu/status": {
"post": {
"tags": [
"权限菜单"
],
"summary": "更新菜单状态",
"description": "根据ID及status更新菜单状态",
"operationId": "app\\api\\controller\\Menu::status",
"parameters": [
{
"$ref": "#/components/parameters/token"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"id",
"status"
],
"properties": {
"id": {
"description": "数据ID或数据ID集合 id=1或 id=1,2,8",
"type": "string"
},
"status": {
"description": "数据状态 0禁用 1启用",
"type": "integer",
"format": "int15"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "删除数据状态",
"content": {
"application/json": {
"schema": {
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示信息",
"type": "string"
},
"count": {
"description": "记录数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "不返回",
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"DemoField": {
"required": [
"id",
"username",
"password",
"sex",
"phone"
],
"properties": {
"username": {
"description": "管理员名称",
"type": "string",
"default": "Jessica Smitch",
"maxLength": 20,
"minLength": 2,
"mock": {
"mock": "@uname"
}
},
"truename": {
"description": "管理员真实姓名",
"type": "string",
"default": "jack ",
"maxLength": 20,
"minLength": 2,
"mock": {
"mock": "@uname"
}
},
"password": {
"description": "管理员密码",
"type": "string",
"default": "",
"maxLength": 20,
"minLength": 6,
"mock": {
"mock": "@string"
}
},
"phone": {
"description": "手机号",
"type": "integer",
"format": "int15",
"default": "",
"maxLength": 11,
"minLength": 11
},
"email": {
"description": "管理员邮箱",
"type": "string",
"default": "",
"maxLength": 50,
"minLength": 5,
"mock": {
"mock": "@email"
}
},
"birthday": {
"description": "管理员生日",
"type": "string",
"format": "datetime",
"default": "2017-02-02 18:31:45"
},
"age": {
"description": "年龄",
"type": "integer",
"format": "int32",
"default": "1",
"maximum": 150,
"exclusiveMaximum": true,
"minimum": 1,
"exclusiveMinimum": true,
"maxLength": 3,
"minLength": 1
}
},
"type": "object"
},
"GroupField": {
"required": [
"id",
"username",
"password",
"sex",
"phone"
],
"properties": {
"title": {
"description": "用户组中文名称",
"type": "string",
"default": "商务部",
"maxLength": 100,
"minLength": 1,
"mock": {
"mock": "@cname"
}
},
"role_code": {
"description": "角色标识",
"type": "string",
"default": "bussiness ",
"maxLength": 100,
"minLength": 1,
"mock": {
"mock": "@name"
}
},
"remark": {
"description": "备注",
"type": "string",
"default": "",
"maxLength": 100,
"minLength": 1,
"mock": {
"mock": "@string"
}
}
},
"type": "object"
},
"GroupMsgExport": {
"required": [
"code",
"msg",
"count",
"data"
],
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示消息",
"type": "string"
},
"count": {
"description": "记录总数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "请求结果",
"type": "array",
"items": {
"properties": {
"id": {
"description": "ID",
"type": "integer"
},
"site_id": {
"description": "站点ID",
"type": "integer"
},
"remark": {
"description": "备注",
"type": "string"
},
"title": {
"description": "用户组中文名称",
"type": "string"
},
"role_code": {
"description": "角色标识",
"type": "string"
},
"status": {
"description": "状态:为1正常,为0禁用",
"type": "integer"
},
"rules": {
"description": "用户组拥有的规则id, 多个规则",
"type": "string"
},
"type": {
"description": "组的类型 1:共用 2:个人",
"type": "integer"
},
"delete_time": {
"description": "是否删除 null:未删除",
"type": "integer"
},
"update_time": {
"description": "更新时间",
"type": "integer"
},
"create_time": {
"description": "创建时间",
"type": "integer"
}
},
"type": "object"
}
}
},
"type": "object"
},
"ManagerField": {
"required": [
"id",
"username",
"password",
"sex",
"phone"
],
"properties": {
"username": {
"description": "管理员名称",
"type": "string",
"default": "Jessica Smitch",
"maxLength": 20,
"minLength": 2,
"mock": {
"mock": "@word"
}
},
"truename": {
"description": "管理员真实姓名",
"type": "string",
"default": "jack ",
"maxLength": 20,
"minLength": 2,
"mock": {
"mock": "@cname"
}
},
"password": {
"description": "管理员密码",
"type": "string",
"default": "",
"maxLength": 20,
"minLength": 6,
"mock": {
"mock": "@string"
}
},
"sex": {
"description": "性别",
"type": "integer",
"format": "int15",
"default": "0",
"maxLength": 1,
"minLength": 1
},
"phone": {
"description": "手机号",
"type": "integer",
"format": "int15",
"default": "",
"maxLength": 11,
"minLength": 11
},
"email": {
"description": "管理员邮箱",
"type": "string",
"default": "",
"maxLength": 50,
"minLength": 5,
"mock": {
"mock": "@email"
}
},
"status": {
"description": "状态",
"type": "integer",
"format": "int15",
"default": "1",
"maxLength": 1,
"minLength": 1
},
"introduction": {
"description": "管理员简介",
"type": "string",
"default": " ",
"maxLength": 200,
"minLength": 1,
"mock": {
"mock": "@cparagraph"
}
}
},
"type": "object"
},
"MenuField": {
"required": [
"id",
"name",
"model_name"
],
"properties": {
"name": {
"description": "权限菜单名称",
"type": "string",
"default": "栏目菜单",
"maxLength": 30,
"minLength": 1,
"mock": {
"mock": "@cname"
}
},
"parent_id": {
"description": "父级ID",
"type": "integer",
"format": "int15",
"default": "0",
"maxLength": 100,
"minLength": 1
},
"model_name": {
"description": "模块名/控制器/方法",
"type": "string",
"default": "/api/menu/index ",
"maxLength": 20,
"minLength": 2,
"mock": {
"mock": "@word"
}
},
"path": {
"description": "权限菜单前端路由",
"type": "string",
"default": "/system/menu"
},
"component": {
"description": "对应前台的模板的路由地址",
"type": "string",
"default": "/system/menu"
},
"authority": {
"description": "按钮权限标识",
"type": "string",
"default": "sys:menu:add"
},
"icon": {
"description": "菜单图标",
"type": "string",
"default": ""
},
"color": {
"description": "icon颜色",
"type": "string",
"default": ""
},
"target": {
"description": "是否新窗口 _target",
"type": "string",
"default": ""
},
"iframe": {
"description": "是否为 iframe模式 0:不是 1:是",
"type": "integer",
"format": "int15",
"default": "0"
},
"hide": {
"description": "是否显示 0:显示 1:隐藏",
"type": "integer",
"format": "int15",
"default": "0",
"maxLength": 1,
"minLength": 1
},
"sort": {
"description": "排序",
"type": "integer",
"format": "int15",
"default": "0",
"maxLength": 100,
"minLength": 1
},
"menu_type": {
"description": "菜单类型 0:菜单 1:按钮",
"type": "integer",
"format": "int15",
"default": "0",
"maxLength": 1,
"minLength": 1
},
"open_type": {
"description": "打开方式 0:组件 1:内链 2:外链",
"type": "integer",
"format": "int15",
"default": "0",
"maxLength": 1,
"minLength": 1
},
"is_dev": {
"description": "1:开发者模式(即tp调试模式开启)",
"type": "integer",
"format": "int15",
"default": "0",
"maxLength": 1,
"minLength": 1
},
"status": {
"description": "状态:为1正常,为0禁用",
"type": "integer",
"format": "int15",
"default": "1",
"maxLength": 1,
"minLength": 1
},
"condition": {
"description": "规则表达式,为空表示存在就验证,不为空表示按照条件验证",
"type": "string",
"default": " ",
"maxLength": 100,
"minLength": 1
},
"remarks": {
"description": "备注",
"type": "string",
"default": " ",
"maxLength": 200,
"minLength": 1
},
"child_list": {
"description": "100100 子集菜单集合",
"type": "string",
"default": " ",
"maxLength": 200,
"minLength": 1
}
},
"type": "object"
},
"ConfigMsgExport": {
"required": [
"code",
"msg",
"count",
"data"
],
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示消息",
"type": "string"
},
"count": {
"description": "数量",
"type": "integer",
"format": "int32"
},
"data": {
"description": "请求结果",
"type": "array",
"items": {
"properties": {
"id": {
"description": "ID",
"type": "integer"
},
"username": {
"description": "管理员名称",
"type": "string"
},
"truename": {
"description": "管理员真实姓名",
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
},
"DemoMsgExport": {
"required": [
"code",
"msg",
"count",
"data"
],
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示消息",
"type": "string"
},
"count": {
"description": "记录总数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "请求结果",
"type": "array",
"items": {
"properties": {
"id": {
"description": "ID",
"type": "integer"
},
"site_id": {
"description": "站点ID",
"type": "integer"
},
"username": {
"description": "管理员名称",
"type": "string"
},
"sex": {
"description": "性别",
"type": "integer"
},
"delete_time": {
"description": "是否删除 null:未删除",
"type": "integer"
},
"update_time": {
"description": "更新时间",
"type": "integer"
},
"create_time": {
"description": "创建时间",
"type": "integer"
}
},
"type": "object"
}
}
},
"type": "object"
},
"LogMsgExport": {
"required": [
"code",
"msg",
"count",
"data"
],
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示消息",
"type": "string"
},
"count": {
"description": "记录总数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "请求结果",
"type": "array",
"items": {
"properties": {
"id": {
"description": "ID",
"type": "integer"
},
"site_id": {
"description": "站点ID",
"type": "integer"
},
"user_id": {
"description": "管理员ID",
"type": "integer"
},
"username": {
"description": "管理员用户名",
"type": "string"
},
"action_ip": {
"description": "执行行为者ip",
"type": "string"
},
"model": {
"description": "操作模块",
"type": "string"
},
"request_param": {
"description": "请求参数",
"type": "string"
},
"url": {
"description": "触发行为完整的url",
"type": "string"
},
"request_method": {
"description": "请求方式",
"type": "string"
},
"spend_time": {
"description": "耗时几秒",
"type": "float"
},
"record_id": {
"description": "触发行为的数据id",
"type": "integer"
},
"remark": {
"description": "日志备注",
"type": "string"
},
"data": {
"description": "修改后数据集合",
"type": "string"
},
"origin": {
"description": "修改前源数据",
"type": "string"
},
"sql": {
"description": "执行的sql记录",
"type": "string"
},
"status": {
"description": "状态 0:禁用 1:启用",
"type": "integer"
},
"client_os": {
"description": "客户端系统类型",
"type": "string"
},
"client_browser": {
"description": "客户端浏览器类型",
"type": "string"
},
"client_device": {
"description": "客户端设备型号,如 phone x 由api传过来",
"type": "string"
},
"delete_time": {
"description": "是否删除 null:未删除",
"type": "integer"
},
"update_time": {
"description": "更新时间",
"type": "integer"
},
"create_time": {
"description": "创建时间",
"type": "integer"
}
},
"type": "object"
}
}
},
"type": "object"
},
"ManagerMsgExport": {
"required": [
"code",
"msg",
"count",
"data"
],
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示消息",
"type": "string"
},
"count": {
"description": "记录总数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "请求结果",
"type": "array",
"items": {
"properties": {
"id": {
"description": "ID",
"type": "integer"
},
"site_id": {
"description": "站点ID",
"type": "integer"
},
"username": {
"description": "管理员名称",
"type": "string"
},
"truename": {
"description": "管理员真实姓名",
"type": "string"
},
"sex": {
"description": "性别",
"type": "integer"
},
"phone": {
"description": "手机号",
"type": "integer"
},
"email": {
"description": "邮箱",
"type": "string"
},
"status": {
"description": "状态",
"type": "integer"
},
"ip": {
"description": "ip",
"type": "integer"
},
"avatar": {
"description": "头像地址",
"type": "string"
},
"introduction": {
"description": "用户简介",
"type": "string"
},
"delete_time": {
"description": "是否删除 null:未删除",
"type": "integer"
},
"login_time": {
"description": "最后登录时间",
"type": "integer"
},
"update_time": {
"description": "更新时间",
"type": "integer"
},
"create_time": {
"description": "创建时间",
"type": "integer"
}
},
"type": "object"
}
}
},
"type": "object"
},
"MenuMsgExport": {
"required": [
"code",
"msg",
"count",
"data"
],
"properties": {
"code": {
"description": "状态码",
"type": "integer",
"format": "int32"
},
"msg": {
"description": "提示消息",
"type": "string"
},
"count": {
"description": "记录总数",
"type": "integer",
"format": "int32"
},
"data": {
"description": "请求结果",
"type": "array",
"items": {
"properties": {
"id": {
"description": "菜单ID",
"type": "integer"
},
"site_id": {
"description": "站点ID",
"type": "integer"
},
"name": {
"description": "菜单名称",
"type": "string"
},
"parent_id": {
"description": "父级ID",
"type": "integer"
},
"model_name": {
"description": "模块名/控制器/方法",
"type": "string"
},
"path": {
"description": "对应前台的模板的路由地址",
"type": "string"
},
"component": {
"description": "前台对应的组件路径",
"type": "string"
},
"authority": {
"description": "按钮权限标识",
"type": "string"
},
"icon": {
"description": "菜单图标",
"type": "string"
},
"color": {
"description": "icon颜色",
"type": "string"
},
"target": {
"description": "是否新窗口 _target/_self",
"type": "string"
},
"iframe": {
"description": "是否为 iframe模式 0:不是 1:是",
"type": "integer"
},
"hide": {
"description": "是否显示 0:显示 1:隐藏",
"type": "integer"
},
"type": {
"description": "在think_auth_rule 表中定义一条规则时,如果type为1, condition字段就可以定义规则表达式。 如定义{score}>5 and {score}<100 表示用户的分数在5-100之间时这条规则才会通过。",
"type": "integer"
},
"sort": {
"description": "排序",
"type": "integer"
},
"menu_type": {
"description": "菜单类型 0:菜单 1:按钮",
"type": "integer"
},
"open_type": {
"description": "打开方式 0:组件 1:内链 2:外链",
"type": "integer"
},
"is_dev": {
"description": "1:开发者模式(即tp调试模式开启)",
"type": "integer"
},
"status": {
"description": "状态:为1正常,为0禁用",
"type": "integer"
},
"condition": {
"description": "规则表达式,为空表示存在就验证,不为空表示按照条件验证",
"type": "string"
},
"remarks": {
"description": "备注",
"type": "string"
},
"child_list": {
"description": "100100 子集菜单集合",
"type": "string"
},
"children": {
"description": "子集菜单对象",
"type": "object"
},
"delete_time": {
"description": "是否删除 null:未删除",
"type": "integer"
},
"update_time": {
"description": "更新时间",
"type": "integer"
},
"create_time": {
"description": "创建时间",
"type": "integer"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"parameters": {
"token": {
"name": "token",
"in": "header",
"description": "用户登录返回的jwt-token值",
"required": true,
"schema": {
"type": "string"
}
}
}
}
}