接口文档

v1.0.0

管理后台/工作台

GET 通用配置

GET /adminapi/config/getConfig

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "oss_domain": "http://www.likeadmin.localhost/",
    "web_name": "likeshop平台",
    "web_favicon": "http://www.likeadmin.localhost/uploads/img.png",
    "web_logo": "http://www.likeadmin.localhost/www.baidu.com222",
    "login_image": "http://www.likeadmin.localhost/www.baidu.com3333",
    "copyright_info": 1111,
    "icp_number": 2222,
    "icp_link": 3333,
    "public_number": 4444,
    "public_link": 5555
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» oss_domainstringtruenone文件域名
»» web_namestringtruenone网站名称
»» web_faviconstringtruenone网站图标
»» web_logostringtruenone网站logo
»» login_imagestringtruenone登录页logo
»» copyright_infointegertruenone版权信息
»» icp_numberintegertruenoneicp备案号
»» icp_linkintegertruenoneicp备案号链接
»» public_numberintegertruenone公安备案号
»» public_linkintegertruenone公安备案号链接

GET 工作台主页

GET /adminapi/Workbench/index

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "version": {
      "version": "1.0.0",
      "website": "likeshop.cn"
    },
    "today": {
      "time": "2021-12-29 16:58:09",
      "today_sales": 100,
      "total_sales": 1000,
      "today_visitor": 10,
      "total_visitor": 100,
      "today_new_user": 30,
      "total_new_user": 3000
    },
    "menu": [
      {
        "name": "工作台",
        "image": "resource/image/adminapi/default/avatar.png",
        "url": "baidu.com"
      },
      {
        "name": "工作台",
        "image": "resource/image/adminapi/default/avatar.png",
        "url": "baidu.com"
      }
    ],
    "visitor": {
      "date": [
        "2021/12/29",
        "2021/12/28",
        "2021/12/27",
        "2021/12/26",
        "2021/12/25",
        "2021/12/24",
        "2021/12/23",
        "2021/12/22",
        "2021/12/21",
        "2021/12/20",
        "2021/12/19",
        "2021/12/18",
        "2021/12/17",
        "2021/12/16",
        "2021/12/15"
      ],
      "list": [
        {
          "name": "访客数",
          "data": [
            40,
            56,
            93,
            39,
            15,
            67,
            93,
            35,
            34,
            8,
            98,
            86,
            88,
            82,
            31
          ]
        }
      ]
    },
    "article": [
      {
        "name": "文章1",
        "read": 1000
      },
      {
        "name": "文章2",
        "read": 800
      },
      {
        "name": "文章3",
        "read": 600
      },
      {
        "name": "文章4",
        "read": 400
      }
    ]
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» versionobjecttruenone版本信息
»»» versionstringtruenone版本信息
»»» websitestringtruenonenone
»» todayobjecttruenone今日数据
»»» timestringtruenonenone
»»» today_salesintegertruenonenone
»»» total_salesintegertruenonenone
»»» today_visitorintegertruenonenone
»»» total_visitorintegertruenonenone
»»» today_new_userintegertruenonenone
»»» total_new_userintegertruenonenone
»» menu[object]truenone常用功能
»»» namestringtruenonenone
»»» imagestringtruenonenone
»»» urlstringtruenonenone
»» visitorobjecttruenone访问量
»»» date[string]truenonenone
»»» list[object]truenonenone
»»»» namestringfalsenonenone
»»»» data[integer]falsenonenone
»» article[object]truenone文章阅读量
»»» namestringtruenonenone
»»» readintegertruenonenone

管理后台/登录

POST 登录

POST /adminapi/login/account

  • 管理员登录

Body 请求参数

account: string
password: string
terminal: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» accountbodystring账号
» passwordbodystring密码
» terminalbodyinteger登录终端;1-pc管理后台;2-手机管理后台

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "name": "超级管理员",
    "avatar": "http://www.likeadmin.localhost/3434",
    "role_name": "",
    "token": "320f928d636b53ded034404e19c48105"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» namestringtruenone管理员昵称
»» avatarstringtruenone管理员头像
»» role_namestringtruenone角色名称
»» tokenstringtruenonetoken

POST 退出登录

POST /adminapi/login/logout

  • 管理员退出

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "success",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/装修管理/首页装修

POST 添加菜单

POST /adminapi/decorate.menu/add

Body 请求参数

name: string
image: string
link_type: 0
link_address: string
sort: 0
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring菜单名称
» imagebodystring菜单图片
» link_typebodyinteger链接类型:1-商城页面;2-商品分类;3-自定义链接
» link_addressbodystring连接地址
» sortbodyinteger排序
» statusbodyinteger状态;1-启用;0-停用

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 菜单详情

GET /adminapi/decorate.menu/detail

请求参数

名称位置类型必选说明
idqueryinteger菜单id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "获取成功",
  "data": {
    "id": 3,
    "name": "地址管理",
    "decorate_type": 1,
    "image": "http://www.smyy.localhost/1111",
    "link_type": 1,
    "link_address": "1",
    "sort": 100,
    "status": 1,
    "create_time": "2022-02-14 15:27:29",
    "update_time": "2022-02-14 15:27:29",
    "delete_time": null
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenone菜单id
»» namestringtruenone菜单名称
»» decorate_typeintegertruenonenone
»» imagestringtruenone菜单图片
»» link_typeintegertruenone链接类型:1-商城页面;2-商品分类;3-自定义链接
»» link_addressstringtruenone链接地址
»» sortintegertruenone排序
»» statusintegertruenone状态;1-启用;0-停用
»» create_timestringtruenonenone
»» update_timestringtruenonenone
»» delete_timenulltruenonenone

GET 商城页面

GET /adminapi/decorate.menu/shopPage

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "获取成功",
  "data": [
    {
      "index": 1,
      "name": "首页",
      "path": "",
      "params": [],
      "type": "shop"
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[object]truenonenone
»» indexintegerfalsenone索引id
»» namestringfalsenone页面名称
»» pathstringfalsenone页面路径
»» params[string]falsenonenone
»» typestringfalsenonenone

POST 编辑菜单

POST /adminapi/decorate.menu/edit

Body 请求参数

id: 0
name: string
image: string
link_type: 0
link_address: string
sort: 0
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger菜单id
» namebodystring菜单名称
» imagebodystring菜单图片
» link_typebodyinteger链接类型:1-商城页面;2-商品分类;3-自定义链接
» link_addressbodystring连接地址
» sortbodyinteger排序
» statusbodyinteger状态;1-启用;0-停用

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 商品分类页面(一级)

GET /adminapi/decorate.menu/goodsCategoryPage

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "获取成功",
  "data": [
    {
      "id": 1,
      "name": "家庭清洁"
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[object]truenonenone
»» idintegerfalsenoneid
»» namestringfalsenone分类名称

GET 菜单列表

GET /adminapi/decorate.menu/lists

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 1,
        "name": "首尔",
        "image": "http://www.smyy.localhost/11111",
        "link_type": 1,
        "link_address": "1",
        "sort": 50,
        "status": 1,
        "link_address_desc": "商城页面:商城首页",
        "status_desc": "停用"
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenone菜单id
»»» namestringfalsenone菜单名称
»»» imagestringfalsenone菜单图片
»»» link_typeintegerfalsenone链接类型:1-商城页面;2-商品分类;3-自定义链接
»»» link_addressstringfalsenone链接地址
»»» sortintegerfalsenone排序
»»» statusintegerfalsenone状态;1-启用;0-停用
»»» link_address_descstringfalsenone地址描述
»»» status_descstringfalsenone状态描述
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

POST 修改菜单状态

POST /adminapi/decorate.menu/status

Body 请求参数

id: 0
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger菜单id
» statusbodyinteger菜单状态

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 删除菜单

POST /adminapi/decorate.menu/del

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger菜单Id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/装修管理/底部导航栏

GET 底部导航详情

GET /adminapi/decorate.navigation/detail

请求参数

名称位置类型必选说明
idqueryinteger导航id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "获取成功",
  "data": {
    "id": 1,
    "name": "我的",
    "selected_icon": "/static/common/image/default/icon_tab_my_s.png",
    "un_selected_icon": "/static/common/image/default/icon_tab_my.png",
    "selected_color": "111",
    "un_selected_color": "2222",
    "create_time": "2021-04-22 16:47:33",
    "update_time": "2021-04-23 15:53:55",
    "delete_time": 0
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenoneid
»» namestringtruenone导航名称
»» selected_iconstringtruenone选中图标
»» un_selected_iconstringtruenone未选中图标
»» selected_colorstringtruenone选中字体颜色
»» un_selected_colorstringtruenone未选中字体颜色
»» create_timestringtruenonenone
»» update_timestringtruenonenone
»» delete_timeintegertruenonenone

POST 编辑底部导航

POST /adminapi/decorate.navigation/edit

Body 请求参数

id: 0
name: string
selected_icon: string
un_selected_icon: string
selected_color: string
un_selected_color: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger导航id
» namebodystring导航名称
» selected_iconbodystring选中图标
» un_selected_iconbodystring未选中图标
» selected_colorbodystring选中字体颜色
» un_selected_colorbodystring未选中字体颜色

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 底部导航列表

GET /adminapi/decorate.navigation/lists

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 2,
        "name": "我的",
        "selected_icon": "/static/common/image/default/icon_tab_my_s.png",
        "un_selected_icon": "/static/common/image/default/icon_tab_my.png",
        "create_time": "2021-04-22 16:47:33",
        "update_time": "2021-04-23 15:53:55",
        "delete_time": 0
      },
      {
        "id": 3,
        "name": "购物车",
        "selected_icon": "/static/common/image/default/icon_tab_shoppingCar.png",
        "un_selected_icon": "/static/common/image/default/icon_tab_shopcart.png",
        "create_time": "2021-04-23 15:50:16",
        "update_time": "2021-04-23 15:53:55",
        "delete_time": 0
      },
      {
        "id": 4,
        "name": "分类",
        "selected_icon": "/static/common/image/default/icon_tab_sort_s.png",
        "un_selected_icon": "/static/common/image/default/icon_tab_sort.png",
        "create_time": "2021-04-23 15:50:32",
        "update_time": "2021-04-23 15:55:15",
        "delete_time": 0
      },
      {
        "id": 5,
        "name": "首页",
        "selected_icon": "/static/common/image/default/icon_tab_home_s.png",
        "un_selected_icon": "/static/common/image/default/icon_tab_home.png",
        "create_time": "2021-04-23 15:52:23",
        "update_time": "2021-04-30 11:02:20",
        "delete_time": 0
      }
    ],
    "count": 4,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegertruenone导航id
»»» namestringtruenone导航名称
»»» selected_iconstringtruenone选中图标
»»» un_selected_iconstringtruenone未选中图标
»»» create_timestringtruenone创建时间
»»» update_timestringtruenonenone
»»» delete_timeintegertruenonenone
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

管理后台/广告管理/广告

GET 广告列表

GET /adminapi/ad.ad/lists

请求参数

名称位置类型必选说明
namequerystring广告名称
statusqueryinteger广告状态:1-启用;0-停用
pidqueryinteger广告位id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 2,
        "name": "元宵节活动",
        "pid": 1,
        "image": "http://www.smyy.localhost/1111",
        "link_type": 1,
        "link_address": "1",
        "sort": 0,
        "status": 1,
        "link_address_desc": "商城页面:商城首页",
        "ap_name": "首页轮播图"
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenone广告id
»»» namestringfalsenone广告名称
»»» pidintegerfalsenone广告位id
»»» imagestringfalsenone广告图
»»» link_typeintegerfalsenone链接类型:1-商城页面;2-商品页面;3-自定义链接
»»» link_addressstringfalsenone链接地址
»»» sortintegerfalsenone排序
»»» statusintegerfalsenone广告状态:1-启用;0-停用
»»» link_address_descstringfalsenone地址描述
»»» ap_namestringfalsenone广告位名称
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

GET 广告详情

GET /adminapi/ad.ad/detail

请求参数

名称位置类型必选说明
idqueryinteger广告id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "获取成功",
  "data": {
    "id": 2,
    "name": "元宵节活动",
    "pid": 1,
    "image": "http://www.smyy.localhost/1111",
    "link_type": 1,
    "link_address": "1",
    "status": 1,
    "sort": 0,
    "create_time": "2022-02-15 09:21:55",
    "update_time": "2022-02-15 09:21:55",
    "delete_time": null
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenone广告id
»» namestringtruenone广告名称
»» pidintegertruenone广告位id
»» imagestringtruenone广告图
»» link_typeintegertruenone链接类型:1-商城页面;2-商品页面;3-自定义链接
»» link_addressstringtruenone链接地址
»» statusintegertruenone广告状态:1-启用;0-停用
»» sortintegertruenone排序
»» create_timestringtruenonenone
»» update_timestringtruenonenone
»» delete_timenulltruenonenone

POST 修改广告状态

POST /adminapi/ad.ad/status

Body 请求参数

id: 0
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger广告id
» statusbodyinteger广告状态:1-启用;0-停用

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 删除广告

POST /adminapi/ad.ad/del

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger广告id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 添加广告

POST /adminapi/ad.ad/add

Body 请求参数

name: string
pid: 0
image: string
link_type: 0
link_address: string
status: 0
sort: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring广告名称
» pidbodyinteger广告位id
» imagebodystring广告图
» link_typebodyinteger链接类型
» link_addressbodystring链接地址
» statusbodyinteger广告状态:1-启用;0-停用
» sortbodyinteger排序

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 编辑广告

POST /adminapi/ad.ad/edit

Body 请求参数

id: 0
name: string
pid: 0
image: string
link_type: 0
link_address: string
status: 0
sort: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger广告id
» namebodystring广告名称
» pidbodyinteger广告位id
» imagebodystring广告图
» link_typebodyinteger链接类型
» link_addressbodystring链接地址
» statusbodyinteger广告状态:1-启用;0-停用
» sortbodyinteger排序

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/广告管理/广告位

POST 修改广告位状态

POST /adminapi/ad.ad_position/status

Body 请求参数

id: 0
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger广告位id
» statusbodyinteger状态:1-启用;0-停用;

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 添加广告位

POST /adminapi/ad.ad_position/add

Body 请求参数

name: string
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring广告位名称
» statusbodyinteger状态:1-启用;0-停用;

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 广告位列表

GET /adminapi/ad.ad_position/lists

请求参数

名称位置类型必选说明
namequerystring广告位名称
attrqueryinteger广告位属性:1-系统默认;2-自定义;

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 3,
        "name": "个人中心广告图",
        "attr": 1,
        "status": 1,
        "create_time": "2022-02-11 10:30:00",
        "attr_desc": "系统默认"
      },
      {
        "id": 2,
        "name": "资讯广告轮播图",
        "attr": 1,
        "status": 1,
        "create_time": "2022-02-11 10:30:00",
        "attr_desc": "系统默认"
      },
      {
        "id": 1,
        "name": "首页轮播图",
        "attr": 1,
        "status": 1,
        "create_time": "2022-02-11 10:30:00",
        "attr_desc": "系统默认"
      }
    ],
    "count": 3,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegertruenone广告位id
»»» namestringtruenone广告位名称
»»» attrintegertruenone广告位属性:1-系统默认;2-自定义;
»»» statusintegertruenone状态:1-启用;0-停用;
»»» create_timestringtruenone创建时间
»»» attr_descstringtruenone属性描述
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

POST 删除广告位

POST /adminapi/ad.ad_position/del

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger广告位id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 编辑广告位

POST /adminapi/ad.ad_position/edit

Body 请求参数

id: 0
name: string
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger广告位id
» namebodystring广告位名称
» statusbodyinteger状态:1-启用;0-停用;

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 广告位详情

GET /adminapi/ad.ad_position/detail

请求参数

名称位置类型必选说明
idqueryinteger广告位id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "获取成功",
  "data": {
    "id": 4,
    "name": "测试",
    "attr": 2,
    "status": 1,
    "create_time": "2022-02-14 17:05:52",
    "update_time": "2022-02-14 17:05:52",
    "delete_time": null
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenoneid
»» namestringtruenone广告位名称
»» attrintegertruenonenone
»» statusintegertruenone状态:1-启用;0-停用;
»» create_timestringtruenonenone
»» update_timestringtruenonenone
»» delete_timenulltruenonenone

管理后台/内容管理/资讯

GET 资讯详情

GET /adminapi/article.article/detail

请求参数

名称位置类型必选说明
idqueryinteger资讯id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "id": 2,
    "cid": 2,
    "title": "买家具全踩坑",
    "image": "http://www.fczj.localhost/uploads/images/202202101117210f3755666.png",
    "content": "这是测试资讯",
    "visit": 0,
    "is_show": 0,
    "create_time": "2022-02-22 10:11:15",
    "update_time": "2022-02-22 10:14:38",
    "delete_time": null
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenone资讯id
»» cidintegertruenone资讯分类id
»» titlestringtruenone资讯标题
»» imagestringtruenone封面
»» contentstringtruenonenone
»» visitintegertruenone浏览量
»» is_showintegertruenone状态:1-显示;0-隐藏
»» create_timestringtruenone发布时间
»» update_timestringtruenonenone
»» delete_timenulltruenonenone

GET 资讯列表

GET /adminapi/article.article/lists

请求参数

名称位置类型必选说明
titlequerystring资讯标题
cidqueryinteger资讯分类id,根据资讯分类-获取所有资讯分类接口获取

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 2,
        "cid": 2,
        "title": "1111",
        "image": "http://www.fczj.localhost/uploads/images/202202101117210f3755666.png",
        "content": "这是测试资讯",
        "visit": 0,
        "is_show": 1,
        "create_time": "2022-02-22 10:11:15",
        "update_time": "2022-02-22 10:19:39",
        "delete_time": null,
        "cate_name": "资讯分类二"
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenone资讯数组
»»» idintegerfalsenonenone
»»» cidintegerfalsenonenone
»»» titlestringfalsenonenone
»»» imagestringfalsenonenone
»»» contentstringfalsenonenone
»»» visitintegerfalsenonenone
»»» is_showintegerfalsenonenone
»»» create_timestringfalsenonenone
»»» update_timestringfalsenonenone
»»» delete_timenullfalsenonenone
»»» cate_namestringfalsenonenone
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

POST 删除资讯

POST /adminapi/article.article/delete

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger资讯id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "删除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 修改资讯状态

POST /adminapi/article.article/updateStatus

Body 请求参数

id: 0
is_show: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger资讯id
» is_showbodyinteger状态:1-显示;0-隐藏

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "修改成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 添加资讯

POST /adminapi/article.article/add

Body 请求参数

title: string
image: string
cid: 0
is_show: 0
content: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» titlebodystring资讯标题
» imagebodystring封面图
» cidbodyinteger所属分类id,根据资讯分类-获取所有资讯分类接口获取
» is_showbodyinteger状态:1-启用;0-停用
» contentbodystring文章内容

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "添加成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 编辑资讯

POST /adminapi/article.article/edit

Body 请求参数

id: string
title: string
image: string
cid: 0
is_show: 0
content: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodystring资讯id
» titlebodystring资讯标题
» imagebodystring封面图
» cidbodyinteger所属分类id,根据资讯分类-获取所有资讯分类接口获取
» is_showbodyinteger状态:1-启用;0-停用
» contentbodystring文章内容

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "编辑成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/内容管理/资讯分类

POST 修改资讯分类状态

POST /adminapi/article.articleCategory/updateStatus

Body 请求参数

id: 0
is_show: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger资讯分类id
» is_showbodyinteger状态:1-启用;0-停用

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "修改成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 资讯分类

GET /adminapi/article.articleCategory/selectArticleCategory

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": [
    {
      "id": 2,
      "name": "资讯分类测试"
    },
    {
      "id": 1,
      "name": "资讯分类一"
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[object]truenonenone
»» idintegertruenonenone
»» namestringtruenonenone

GET 资讯分类详情

GET /adminapi/article.articleCategory/detail

请求参数

名称位置类型必选说明
idqueryinteger资讯分类id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "",
  "data": {
    "id": 2,
    "name": "资讯分类测试",
    "sort": 2,
    "is_show": 0,
    "create_time": "2022-02-21 17:47:58",
    "update_time": "2022-02-21 17:53:20",
    "delete_time": null
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenonenone
»» namestringtruenonenone
»» sortintegertruenonenone
»» is_showintegertruenonenone
»» create_timestringtruenonenone
»» update_timestringtruenonenone
»» delete_timenulltruenonenone

POST 删除资讯分类

POST /adminapi/article.articleCategory/delete

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger资讯分类id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "删除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 编辑资讯分类

POST /adminapi/article.articleCategory/edit

Body 请求参数

id: 0
name: string
sort: 0
is_show: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger资讯分类id
» namebodystring资讯分类名称
» sortbodyinteger排序
» is_showbodyinteger状态:1-启用;0-停用

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "编辑成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 资讯分类列表

GET /adminapi/article.articleCategory/lists

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 2,
        "name": "资讯分类测试",
        "sort": 2,
        "is_show": 0,
        "create_time": "2022-02-21 17:47:58",
        "update_time": "2022-02-21 17:53:20",
        "delete_time": null,
        "is_show_desc": "停用"
      },
      {
        "id": 1,
        "name": "资讯分类一",
        "sort": 0,
        "is_show": 1,
        "create_time": "2022-02-21 17:25:22",
        "update_time": null,
        "delete_time": null,
        "is_show_desc": "启用"
      }
    ],
    "count": 2,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenone资讯分类数组
»»» idintegertruenonenone
»»» namestringtruenonenone
»»» sortintegertruenonenone
»»» is_showintegertruenonenone
»»» create_timestringtruenonenone
»»» update_timestring¦nulltruenonenone
»»» delete_timenulltruenonenone
»»» is_show_descstringtruenonenone
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

POST 添加资讯分类

POST /adminapi/article.articleCategory/add

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "添加成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/应用管理/消息通知/短信配置

POST 设置短信配置

POST /adminapi/notice.sms_config/setConfig

Body 请求参数

type: string
sign: string
app_key: string
secret_key: string
status: string
app_id: string
secret_id: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» typebodystringali-阿里云;tencent-腾讯云
» signbodystring短信签名
» app_keybodystringtype=ali时必填
» secret_keybodystringnone
» statusbodystring状态
» app_idbodystringtype=tencent时必填
» secret_idbodystringtype=tencent时必填

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 通知设置详情

GET /adminapi/notice.notice/detail

请求参数

名称位置类型必选说明
idqueryinteger短信通知id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "id": 1,
    "scene_id": 100,
    "scene_name": "登录验证码",
    "scene_desc": "用户手机号码登录时发送",
    "system_notice": {
      "title": "",
      "content": "",
      "status": 0,
      "tips": [
        "可选变量 验证码:code"
      ],
      "is_show": false
    },
    "sms_notice": {
      "template_id": "1234",
      "content": "65465464654654654",
      "status": "1",
      "tips": [
        "可选变量 验证码:code",
        "示例:您正在申请注册,验证码${code},切勿将验证码泄露于他人,本条验证码有效期5分钟。",
        "生效条件:1、管理后台完成短信设置。 2、第三方短信平台申请模板 3、若是腾讯云模板变量名须换成变量名出现顺序对应的数字(例:您好{nickname},您的订单{order_sn}已发货! 须改为 您好{1},您的订单{2}已发货!)"
      ],
      "is_show": true
    },
    "oa_notice": {
      "template_id": "",
      "template_sn": "",
      "name": "",
      "first": "",
      "remark": "",
      "tpl": [],
      "status": 0,
      "tips": [
        "可选变量 验证码:code",
        "配置路径:小程序后台 > 功能 > 订阅消息"
      ],
      "is_show": false
    },
    "mnp_notice": {
      "template_id": "",
      "template_sn": "",
      "name": "",
      "tpl": [],
      "status": 0,
      "tips": [
        "可选变量 验证码:code",
        "配置路径:小程序后台 > 功能 > 订阅消息"
      ],
      "is_show": false
    },
    "support": "2",
    "default": ""
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenonenone
»» scene_idintegertruenonenone
»» scene_namestringtruenone场景名称
»» scene_descstringtruenone场景描述
»» system_noticeobjecttruenone系统通知设置
»»» titlestringtruenonenone
»»» contentstringtruenonenone
»»» statusintegertruenonenone
»»» tips[string]truenone默认提示
»»» is_showbooleantruenonenone
»» sms_noticeobjecttruenone短信通知设置
»»» template_idstringtruenonenone
»»» contentstringtruenonenone
»»» statusstringtruenonenone
»»» tips[string]truenone默认提示
»»» is_showbooleantruenonenone
»» oa_noticeobjecttruenone公众号模板消息设置
»»» template_idstringtruenonenone
»»» template_snstringtruenonenone
»»» namestringtruenonenone
»»» firststringtruenonenone
»»» remarkstringtruenonenone
»»» tpl[string]truenonenone
»»» statusintegertruenonenone
»»» tips[string]truenone默认提示
»»» is_showbooleantruenonenone
»» mnp_noticeobjecttruenone小程序订阅消息设置
»»» template_idstringtruenonenone
»»» template_snstringtruenonenone
»»» namestringtruenonenone
»»» tpl[string]truenonenone
»»» statusintegertruenonenone
»»» tips[string]truenone默认提示
»»» is_showbooleantruenonenone
»» supportstringtruenonenone
»» defaultstringtruenonenone

GET 短信通知列表

GET /adminapi/notice.notice/settingLists

请求参数

名称位置类型必选说明
recipientqueryinteger接收对象 1-买家 2-卖家
typequeryinteger通知类型 1-业务通知 2-验证码

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 1,
        "scene_name": "登录验证码",
        "sms_status_desc": "启用",
        "type_desc": "验证码"
      },
      {
        "id": 2,
        "scene_name": "收货码通知",
        "sms_status_desc": "启用",
        "type_desc": "验证码"
      }
    ],
    "count": 2,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegertruenoneid
»»» scene_namestringtruenone通知名称
»»» sms_status_descstringtruenone短信通知状态
»»» type_descstringtruenone通知类型
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

GET 短信设置详情

GET /adminapi/notice.sms_config/detail

请求参数

名称位置类型必选说明
typequerystring参数:ali-阿里云 tencent-腾讯云

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "sign": "",
    "app_key": "",
    "secret_key": "",
    "status": 1,
    "name": "阿里云短信"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» signstringtruenonenone
»» app_keystringtruenonenone
»» secret_keystringtruenonenone
»» statusintegertruenonenone
»» namestringtruenonenone

GET 短信设置列表

GET /adminapi/notice.sms_config/getConfig

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "ali": {
      "name": "阿里云短信",
      "status": 0
    },
    "tencent": {
      "name": "腾讯云短信",
      "status": 0
    }
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» aliobjecttruenonenone
»»» namestringtruenone名称
»»» statusintegertruenone状态
»» tencentobjecttruenonenone
»»» namestringtruenone名称
»»» statusintegertruenone状态

POST 设置通知配置

POST /adminapi/notice.notice/set

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/渠道设置/小程序

GET 获取小程序配置

GET /adminapi/channel.mnp_settings/getConfig

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "name": "演示小程序",
    "original_id": 123456,
    "qr_code": "http://www.smyy.localhost/1111",
    "app_id": 654321,
    "app_secret": "asdasdsaerfas",
    "request_domain": "https://www.smyy.localhost",
    "socket_domain": "wss://www.smyy.localhost",
    "upload_file_domain": "https://www.smyy.localhost",
    "download_file_domain": "https://www.smyy.localhost",
    "udp_domain": "udp://www.smyy.localhost",
    "business_domain": "www.smyy.localhost"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» namestringtruenone小程序名称
»» original_idintegertruenone原始id
»» qr_codestringtruenone二维码
»» app_idintegertruenonenone
»» app_secretstringtruenonenone
»» request_domainstringtruenonerequest合法域名
»» socket_domainstringtruenonesocket合法域名
»» upload_file_domainstringtruenoneuploadFile合法域名
»» download_file_domainstringtruenonedownloadFile合法域名
»» udp_domainstringtruenoneudp合法域名
»» business_domainstringtruenone业务域名

POST 设置小程序配置

POST /adminapi/channel.mnp_settings/setConfig

Body 请求参数

name: string
original_id: string
qr_code: string
app_id: string
app_secret: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring小程序名称
» original_idbodystring原始ID
» qr_codebodystring小程序码
» app_idbodystringAppID
» app_secretbodystringAppSecret

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/渠道设置/公众号

GET 获取菜单详情

GET /adminapi/channel.official_account_menu/detail

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": [
    {
      "name": "公司产品",
      "type": "click",
      "key": "product",
      "sub_button": [
        {
          "name": "LikeShop",
          "type": "click",
          "key": "ls"
        },
        {
          "name": "LikeMall",
          "type": "view",
          "url": "https://lm.html"
        }
      ]
    },
    {
      "name": "活动",
      "type": "view",
      "url": "https://activity.html"
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[object]truenonenone
»» namestringtruenone菜单名称
»» typestringtruenone菜单类型 click-关键字 view-跳转网页链接 miniprogram- 小程序
»» keystringfalsenonenone
»» sub_button[object]falsenonenone
»»» namestringtruenonenone
»»» typestringtruenonenone
»»» keystringfalsenonenone
»»» urlstringfalsenonenone
»» urlstringfalsenone网页链接 菜单类型为view或miniprogram必填

GET 获取公众号配置

GET /adminapi/channel.official_account_setting/getConfig

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "name": "演示公众号",
    "original_id": 123456,
    "qr_code": "http://www.smyy.localhost/1111",
    "app_id": 654321,
    "app_secret": "asdssdSdsgsefa",
    "url": "http://www.smyy.localhost/adminapi/wechat.official_account_reply/index",
    "token": "likeAdmin",
    "encoding_aes_key": "asdas",
    "encryption_type": 1,
    "business_domain": "www.smyy.localhost",
    "js_secure_domain": "www.smyy.localhost",
    "web_auth_domain": "www.smyy.localhost"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» namestringtruenone公众号名称
»» original_idintegertruenone原始id
»» qr_codestringtruenone二维码
»» app_idintegertruenonenone
»» app_secretstringtruenonenone
»» urlstringtruenonenone
»» tokenstringtruenonenone
»» encoding_aes_keystringtruenonenone
»» encryption_typeintegertruenone消息加密方式 1-明文模式 2-兼容模式 3-安全模式
»» business_domainstringtruenone业务域名
»» js_secure_domainstringtruenoneJS接口安全域名
»» web_auth_domainstringtruenone网页授权域名

POST 更新状态

POST /adminapi/channel.official_account_reply/status

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger回复记录id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 更新排序

POST /adminapi/channel.official_account_reply/sort

Body 请求参数

id: 0
new_sort: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger回复记录id
» new_sortbodyinteger新排序值

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 保存/保存并发布菜单

POST /adminapi/channel.official_account_menu/save

Body 请求参数

name: string
type: string
key: string
url: string
appid: string
pagepath: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring菜单名称
» typebodystring菜单类型 click-关键字 view-跳转网页链接 miniprogram- 小程序
» keybodystring关键字 菜单类型为click必填
» urlbodystring网页链接 菜单类型为view或miniprogram必填
» appidbodystringappid 菜单类型为miniprogram必填
» pagepathbodystring小程序路径 菜单类型为miniprogram必填

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 删除回复

POST /adminapi/channel.official_account_reply/delete

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger回复记录id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 新增回复(关注/关词词/默认)

POST /adminapi/channel.official_account_reply/add

Body 请求参数

reply_type: 0
name: string
content_type: 0
content: string
status: 0
keyword: string
matching_type: 0
sort: 0
reply_num: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» reply_typebodyinteger回复类型 1-关注回复 2-关键词回复 3-默认回复
» namebodystring规格名称
» content_typebodyinteger内容类型 1-文本
» contentbodystring内容
» statusbodyinteger启用状态 0-禁用 1-开启
» keywordbodystring关键词 关键词回复必填
» matching_typebodyinteger匹配方式 1-全匹配 2-模糊匹配 关键词回复必填
» sortbodyinteger排序值关键词回复必填
» reply_numbodyinteger回复数量关键词回复必填

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 编辑回复(关注/关键词/默认)

POST /adminapi/channel.official_account_reply/edit

Body 请求参数

id: 0
reply_type: 0
name: string
content_type: 0
content: string
status: 0
keyword: string
matching_type: 0
sort: 0
reply_num: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger回复记录id
» reply_typebodyinteger回复类型 1-关注回复 2-关键词回复 3-默认回复
» namebodystring规格名称
» content_typebodyinteger内容类型 1-文本
» contentbodystring内容
» statusbodyinteger启用状态 0-禁用 1-开启
» keywordbodystring关键词 关键词回复必填
» matching_typebodyinteger匹配方式 1-全匹配 2-模糊匹配 关键词回复必填
» sortbodyinteger排序值关键词回复必填
» reply_numbodyinteger回复数量关键词回复必填

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 回复列表

GET /adminapi/channel.official_account_reply/lists

请求参数

名称位置类型必选说明
reply_typequeryinteger回复类型 1-关注回复 2-关键词回复 3-默认回复

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 14,
        "name": "在不在",
        "keyword": "在?",
        "matching_type": 1,
        "content_type": 1,
        "status": 1,
        "sort": 999,
        "matching_type_desc": "全匹配",
        "content_type_desc": "文本",
        "status_desc": "开启"
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenone回复记录id
»»» namestringfalsenone规格名称
»»» keywordstringfalsenone关键词
»»» matching_typeintegerfalsenone匹配方式 1-全匹配 2-模糊匹配
»»» content_typeintegerfalsenonenone
»»» statusintegerfalsenone启用状态 0-禁用 1-开启
»»» sortintegerfalsenone排序值
»»» matching_type_descstringfalsenonenone
»»» content_type_descstringfalsenonenone
»»» status_descstringfalsenonenone
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

GET 获取回复详情

GET /adminapi/channel.official_account_reply/detail

请求参数

名称位置类型必选说明
idqueryinteger回复记录id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "id": 10,
    "name": "在不在",
    "keyword": "在吗",
    "reply_type": "2",
    "matching_type": 1,
    "content_type": 1,
    "content": "在的呀~有什么可以帮到您",
    "status": 0,
    "sort": 20,
    "reply_type_desc": "关键词回复",
    "matching_type_desc": "全匹配",
    "content_type_desc": "文本",
    "status_desc": "禁用"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenone回复记录id
»» namestringtruenone规格名称
»» keywordstringtruenone关键词
»» reply_typestringtruenone回复类型 1-关注回复 2-关键词回复 3-默认回复
»» matching_typeintegertruenone匹配方式 1-全匹配 2-模糊匹配
»» content_typeintegertruenonenone
»» contentstringtruenone内容
»» statusintegertruenone启用状态 0-禁用 1-开启
»» sortintegertruenone排序值
»» reply_type_descstringtruenonenone
»» matching_type_descstringtruenonenone
»» content_type_descstringtruenonenone
»» status_descstringtruenonenone

POST 设置公众号配置

POST /adminapi/channel.official_account_setting/setConfig

Body 请求参数

name: string
original_id: string
qr_code: string
app_id: string
app_secret: string
token: string
encoding_aes_key: string
encryption_type: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring公众号名称
» original_idbodystring原始id
» qr_codebodystring二维码
» app_idbodystringAppID
» app_secretbodystringAppSecret
» tokenbodystringToken
» encoding_aes_keybodystringEncodingAESKey
» encryption_typebodystring消息加密方式 1-明文模式 2-兼容模式 3-安全模式

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/渠道设置/H5

GET 获取H5设置

GET /adminapi/channel.h5_setting/getConfig

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "status": 1,
    "url": "https://www.likeshopb2cv3.localhost/h5"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» statusintegertruenone状态 0-关闭 1-开启
»» urlstringtruenone访问链接

POST H5设置

POST /adminapi/channel.h5_setting/setConfig

Body 请求参数

status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» statusbodyinteger状态 0-关闭 1-开启

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/渠道设置/APP

POST APP设置

POST /adminapi/channel.app_setting/setConfig

Body 请求参数

ios_download_url: string
android_download_url: string
download_title: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» ios_download_urlbodystring苹果APP下载链接
» android_download_urlbodystring安卓APP下载链接
» download_titlebodystringAPP下载引导文案

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 获取APP设置

GET /adminapi/channel.app_setting/getConfig

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "ios_download_url": "ios.html",
    "android_download_url": "android.html",
    "download_title": "下载有礼"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» ios_download_urlstringtruenone苹果APP下载链接
»» android_download_urlstringtruenone安卓APP下载链接
»» download_titlestringtruenoneAPP下载引导文案

管理后台/渠道设置/微信开放平台

GET 获取微信开放平台设置

GET /adminapi/channel.open_setting/getConfig

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "app_id": 8888,
    "app_secret": 9999
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» app_idintegertruenone开放平台appid
»» app_secretintegertruenone开放平台appSecret

POST 微信开放平台设置

POST /adminapi/channel.open_setting/setConfig

Body 请求参数

app_id: string
app_secret: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» app_idbodystring开放平台app_id
» app_secretbodystring开放平台app_secret

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/组织管理/部门管理

GET 列表

GET /adminapi/dept.dept/lists

  • 部门列表

请求参数

名称位置类型必选说明
statusqueryinteger状态 0-停用 1-正常
namequerystring名称

返回示例

成功

"{\n    \"code\": 1,\n    \"show\": 0,\n    \"msg\": \"\",\n    \"data\": [\n        {\n            \"id\": 1,\n            \"name\": \"公司\",\n            \"pid\": 0,\n            \"sort\": 0,\n            \"leader\": \"boss\",\n            \"mobile\": \"123\",\n            \"status\": 1,\n            \"create_time\": \"2022-04-22 09:58:04\",\n            \"update_time\": \"2022-05-27 16:32:48\",\n            \"delete_time\": null,\n            \"status_desc\": \"正常\",\n            \"level\": 0,\n            \"children\": [\n                {\n                    \"id\": 4,\n                    \"name\": \"前端前端\",\n                    \"pid\": 1,\n                    \"sort\": 5,\n                    \"leader\": \"007007\",\n                    \"mobile\": \"15216949486\",\n                    \"status\": 1,\n                    \"create_time\": \"2022-05-27 10:29:35\",\n                    \"update_time\": \"2022-05-27 16:55:09\",\n                    \"delete_time\": null,\n                    \"status_desc\": \"正常\",\n                    \"level\": 1,\n                    \"children\": []\n            ]\n        }\n    ]\n}"

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

POST 删除

POST /adminapi/dept.dept/delete

  • 删除部门

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger部门id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "删除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 详情

GET /adminapi/dept.dept/detail

  • 部门详情

请求参数

名称位置类型必选说明
idqueryinteger部门id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "id": 1,
    "name": "公司",
    "pid": 0,
    "sort": 0,
    "leader": "测试先生",
    "mobile": "13104997836",
    "status": 1,
    "create_time": "2022-05-26 14:45:24",
    "update_time": "2022-05-26 14:45:24",
    "delete_time": null
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenonenone
»» namestringtruenone部门名称
»» pidintegertruenone上级部门id
»» sortintegertruenonenone
»» leaderstringtruenone负责人
»» mobilestringtruenone联系方式
»» statusintegertruenone状态 0-停用 1-正常
»» create_timestringtruenonenone
»» update_timestringtruenonenone
»» delete_timenulltruenonenone

POST 编辑

POST /adminapi/dept.dept/edit

  • 编辑部门

Body 请求参数

id: 0
pid: 0
name: string
leader: string
mobile: string
sort: 0
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyintegerid
» pidbodyinteger上级部门id
» namebodystring部门名称
» leaderbodystring负责人
» mobilebodystring联系电话
» sortbodyinteger排序
» statusbodyinteger状态 0-停用 1-正常

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "编辑成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 添加

POST /adminapi/dept.dept/add

  • 添加部门

Body 请求参数

pid: 0
name: string
leader: string
mobile: string
sort: 0
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» pidbodyinteger上级部门id
» namebodystring部门名称
» leaderbodystring负责人
» mobilebodystring联系电话
» sortbodyinteger排序
» statusbodyinteger状态 0-停用 1-正常

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "添加成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 上级部门

GET /adminapi/dept.dept/leaderDept

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "添加成功",
  "data": [
    {
      "id": 4,
      "name": "研发部门"
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[object]truenonenone
»» idintegerfalsenonenone
»» namestringfalsenonenone

管理后台/组织管理/岗位管理

POST 删除

POST /adminapi/dept.jobs/delete

  • 删除岗位

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger岗位id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "删除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 列表

GET /adminapi/dept.jobs/lists

  • 岗位列表

请求参数

名称位置类型必选说明
codequerystring编码
statusqueryinteger状态 0-停用 1-正常
namequerystring岗位名称

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 4,
        "name": "普通员工",
        "code": "user",
        "sort": 4,
        "status": 0,
        "remark": "111",
        "create_time": null,
        "update_time": null,
        "delete_time": null,
        "status_desc": "停用"
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone编码
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenonenone
»»» namestringfalsenone岗位名称
»»» codestringfalsenone编码
»»» sortintegerfalsenone排序
»»» statusintegerfalsenone状态 0-停用 1-正常
»»» remarkstringfalsenonenone
»»» create_timenullfalsenone创建时间
»»» update_timenullfalsenonenone
»»» delete_timenullfalsenonenone
»»» status_descstringfalsenone状态描述
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

POST 编辑

POST /adminapi/dept.jobs/edit

  • 编辑岗位

Body 请求参数

id: 0
name: string
code: string
sort: 0
remark: string
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyintegerid
» namebodystring名称
» codebodystring编码
» sortbodyinteger排序
» remarkbodystring备注
» statusbodyinteger状态 0-停用 1-正常

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "编辑成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 详情

GET /adminapi/dept.jobs/detail

  • 岗位详情

请求参数

名称位置类型必选说明
idqueryintegerid

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "id": 4,
    "name": "普通员工",
    "code": "user",
    "sort": 4,
    "status": 0,
    "remark": "111",
    "create_time": null,
    "update_time": null,
    "delete_time": null
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenone编码
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenonenone
»» namestringtruenone岗位名称
»» codestringtruenone编码
»» sortintegertruenone排序
»» statusintegertruenone状态 0-停用 1-正常
»» remarkstringtruenone备注
»» create_timenulltruenonenone
»» update_timenulltruenonenone
»» delete_timenulltruenonenone

POST 添加

POST /adminapi/dept.jobs/add

  • 添加岗位

Body 请求参数

name: string
code: string
sort: 0
remark: string
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring名称
» codebodystring编码
» sortbodyinteger排序
» remarkbodystring备注
» statusbodyinteger状态 0-停用 1-正常

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "添加成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/权限管理/管理员

POST 编辑管理员

POST /adminapi/auth.admin/edit

Body 请求参数

id: 0
name: string
account: string
password: string
password_confirm: string
role_id: string
disable: string
multipoint_login: 0
avatar: string
dept_id: 0
jobs_id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger管理员id
» namebodystring名称
» accountbodystring账号
» passwordbodystring密码
» password_confirmbodystring确认密码
» role_idbodystring角色id
» disablebodystring是否禁用:0-否;1-是;
» multipoint_loginbodyinteger是否支持多处登录:1-是;0-否
» avatarbodystring头像
» dept_idbodyinteger部门id
» jobs_idbodyinteger岗位id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "编辑成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 管理员列表

GET /adminapi/auth.admin/lists

请求参数

名称位置类型必选说明
accountquerystring搜索账号
namequerystring搜索名称
role_idqueryinteger搜素角色-角色id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 1,
        "name": "超级管理员",
        "account": "admin",
        "role_id": 1,
        "create_time": "1970-01-14 04:38:31",
        "disable": 0,
        "login_time": "2021-12-29 09:33:46",
        "login_ip": "172.19.0.1",
        "multipoint_login": 0,
        "avatar": "http://www.likeadmin.localhost/3434",
        "dept_name": "广州公司",
        "disable_desc": "正常",
        "role_name": "管理员"
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenoneid
»»» namestringfalsenone管理员昵称
»»» accountstringfalsenone管理员账号
»»» role_idintegerfalsenonenone
»»» create_timestringfalsenone创建时间
»»» disableintegerfalsenonenone
»»» login_timestringfalsenone最近登录时间
»»» login_ipstringfalsenone最近登录ip
»»» multipoint_loginintegerfalsenonenone
»»» avatarstringfalsenone管理员头像
»»» dept_namestringfalsenone部门名称
»»» disable_descstringfalsenonenone
»»» role_namestringfalsenone管理员头像
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

GET 管理员详情

GET /adminapi/auth.admin/detail

请求参数

名称位置类型必选说明
idqueryintegerid

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "account": "admin2",
    "name": "管理员2号",
    "role_id": 1,
    "disable": 1,
    "multipoint_login": 1,
    "avatar": "http://www.likeadmin.localhost/xxxx.png"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» accountstringtruenone管理员账号
»» namestringtruenone管理员昵称
»» role_idintegertruenone角色id
»» disableintegertruenone是否禁用:0-否;1-是;
»» multipoint_loginintegertruenonenone
»» avatarstringtruenone管理员头像

POST 删除管理员

POST /adminapi/auth.admin/delete

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger管理员id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "删除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 添加管理员

POST /adminapi/auth.admin/add

Body 请求参数

name: string
account: string
password: string
password_confirm: string
role_id: string
disable: string
multipoint_login: 0
avatar: string
dept_id: 0
jobs_id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring名称
» accountbodystring账号
» passwordbodystring密码
» password_confirmbodystring确认密码
» role_idbodystring角色id
» disablebodystring是否禁用:0-否;1-是;
» multipoint_loginbodyinteger是否支持多处登录:1-是;0-否
» avatarbodystring头像
» dept_idbodyinteger部门id
» jobs_idbodyinteger岗位id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "添加成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/权限管理/角色

GET 获取权限

GET /adminapi/config/getAuth

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "root": 0,
    "auth": {
      "/workbench/index": [
        "view"
      ],
      "/permissions/admin/index": [
        "view",
        "auth_all"
      ],
      "/permissions/role/index": [
        "view",
        "auth_all"
      ],
      "/setting/website/information": [],
      "/setting/website/filing": [],
      "/setting/system/environment": []
    }
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» rootintegertruenonenone
»» authobjecttruenonenone
»»» anonymous[string]falsenonenone
»»» anonymous[string]falsenonenone
»»» anonymous[string]falsenonenone
»»» anonymous[string]falsenonenone
»»» anonymous[string]falsenonenone
»»» anonymous[string]falsenonenone

GET 角色详情

GET /adminapi/auth.role/detail

请求参数

名称位置类型必选说明
idqueryinteger角色id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "id": 1,
    "name": "哈哈哈哈",
    "desc": "222222",
    "menu_id": [
      12,
      55
    ]
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenonenone
»» namestringtruenonenone
»» descstringtruenonenone
»» menu_id[integer]truenonenone

GET 获取菜单

GET /adminapi/config/getMenu

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": [
    {
      "name": "工作台",
      "type": 1,
      "sons": [
        {
          "name": "查看",
          "type": 2,
          "auth_key": "index/index.view"
        }
      ]
    },
    {
      "name": "权限管理",
      "type": 1,
      "sons": [
        {
          "name": "管理员",
          "type": 1,
          "sons": [
            {
              "name": "查看",
              "type": 2,
              "auth_key": "auth/permissions.view"
            },
            {
              "name": "管理",
              "type": 2,
              "auth_key": "auth/permissions.manage"
            }
          ]
        },
        {
          "name": "角色",
          "type": 1,
          "sons": [
            {
              "name": "查看",
              "type": 2,
              "auth_key": "auth/role.view"
            },
            {
              "name": "管理",
              "type": 2,
              "auth_key": "auth/role.manage"
            }
          ]
        }
      ]
    },
    {
      "name": "系统设置",
      "type": 1,
      "sons": [
        {
          "name": "网站信息",
          "type": 1,
          "sons": [
            {
              "name": "查看",
              "type": 2,
              "auth_key": "setting/website.view"
            },
            {
              "name": "保存",
              "type": 2,
              "auth_key": "setting/website.save"
            }
          ]
        },
        {
          "name": "备案信息",
          "type": 1,
          "sons": [
            {
              "name": "查看",
              "type": 2,
              "auth_key": "setting/record.view"
            },
            {
              "name": "保存",
              "type": 2,
              "auth_key": "setting/record.save"
            }
          ]
        },
        {
          "name": "系统环境",
          "type": 2,
          "sons": [
            {
              "name": "查看",
              "type": 2,
              "auth_key": "setting/environment.view"
            },
            {
              "name": "保存",
              "type": 2,
              "auth_key": "setting/environment.save"
            }
          ]
        }
      ]
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[object]truenonenone
»» namestringtruenone菜单/权限名称
»» typeintegertruenone类型:1-菜单;2-权限
»» sons[object]truenonenone
»»» namestringtruenonenone
»»» typeintegertruenonenone
»»» auth_keystringfalsenonenone
»»» sons[object]truenonenone
»»»» namestringtruenonenone
»»»» typeintegertruenonenone
»»»» auth_keystringtruenonenone

POST 删除角色

POST /adminapi/auth.role/del

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger角色id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "删除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 编辑角色

POST /adminapi/auth.role/edit

Body 请求参数

id: 0
name: string
desc: string
menu_id: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger角色id
» namebodystring角色名称
» descbodystring备注
» menu_idbodystring权限id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "编辑成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 添加角色

POST /adminapi/auth.role/add

Body 请求参数

name: string
desc: string
menu_id: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring角色名称
» descbodystring备注
» menu_idbodystring权限id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "添加成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 角色列表

GET /adminapi/auth.role/lists

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 1,
        "name": "管理员1号",
        "desc": "222222",
        "create_time": "2021-12-28 18:54:52",
        "num": 1
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenone角色id
»»» namestringfalsenone角色名称
»»» descstringfalsenone备注
»»» create_timestringfalsenone创建时间
»»» numintegerfalsenone使用该角色的人数
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

管理后台/权限管理/菜单

GET 菜单详情

GET /adminapi/auth.menu/detail

-菜单详情

请求参数

名称位置类型必选说明
idqueryintegerid

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "id": 38,
    "pid": 0,
    "type": "M",
    "name": "测试顶级11",
    "icon": "",
    "sort": 11,
    "perms": "",
    "paths": "",
    "component": "",
    "selected": "",
    "params": "",
    "is_cache": 1,
    "is_show": 1,
    "is_disable": 0,
    "create_time": "2022-06-30 10:08:43",
    "update_time": "2022-06-30 10:11:36"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenonenone
»» pidintegertruenone父级id
»» typestringtruenone类型: M=目录, C=菜单, A=按钮
»» namestringtruenone名称
»» iconstringtruenone图标
»» sortintegertruenone排序号 大到小
»» permsstringtruenone权限链接
»» pathsstringtruenonenone
»» componentstringtruenone前端组件
»» selectedstringtruenone选中路径
»» paramsstringtruenone路由参数
»» is_cacheintegertruenone是否缓存 0=否, 1=是
»» is_showintegertruenone是否显示 0=否, 1=是
»» is_disableintegertruenone是否禁用 0=否, 1=是
»» create_timestringtruenonenone
»» update_timestringtruenonenone

POST 编辑菜单

POST /adminapi/auth.menu/edit

Body 请求参数

id: 0
pid: 0
type: string
name: string
icon: string
sort: 0
perms: string
paths: string
component: string
selected: string
params: string
is_cache: string
is_show: string
is_disable: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyintegerid
» pidbodyinteger父级id
» typebodystring类型: M=目录, C=菜单, A=按钮
» namebodystring名称
» iconbodystring图标
» sortbodyinteger排序号 大到小
» permsbodystring权限链接
» pathsbodystring路由地址
» componentbodystring前端组件
» selectedbodystring选中路径
» paramsbodystring路由参数
» is_cachebodystring是否缓存 0=否, 1=是
» is_showbodystring是否显示 0=否, 1=是
» is_disablebodyinteger是否禁用 0=否, 1=是

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 角色菜单

GET /adminapi/auth.menu/route

  • 获取当前角色菜单

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": [
    {
      "id": 19,
      "pid": 0,
      "type": "M",
      "name": "系统设置",
      "icon": "icon_sort",
      "sort": 100,
      "perms": "",
      "paths": "setting",
      "component": "",
      "selected": "",
      "params": "",
      "is_cache": 0,
      "is_show": 1,
      "is_disable": 0,
      "create_time": "2022-04-20 10:41:03",
      "update_time": "2022-04-25 18:52:35",
      "children": []
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[object]truenonenone
»» idintegerfalsenonenone
»» pidintegerfalsenone父级id
»» typestringfalsenone类型: M=目录, C=菜单, A=按钮
»» namestringfalsenone名称
»» iconstringfalsenone图标
»» sortintegerfalsenone排序号 大到小
»» permsstringfalsenone权限链接
»» pathsstringfalsenonenone
»» componentstringfalsenone前端组件
»» selectedstringfalsenone选中路径
»» paramsstringfalsenone路由参数
»» is_cacheintegerfalsenone是否缓存 0=否, 1=是
»» is_showintegerfalsenone是否显示 0=否, 1=是
»» is_disableintegerfalsenone是否禁用 0=否, 1=是
»» create_timestringfalsenonenone
»» update_timestringfalsenonenone
»» children[string]falsenonenone

POST 添加菜单

POST /adminapi/auth.menu/add

Body 请求参数

pid: 0
type: string
name: string
icon: string
sort: 0
perms: string
paths: string
component: string
selected: string
params: string
is_cache: string
is_show: string
is_disable: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» pidbodyinteger父级id
» typebodystring类型: M=目录, C=菜单, A=按钮
» namebodystring名称
» iconbodystring图标
» sortbodyinteger排序号 大到小
» permsbodystring权限链接
» pathsbodystring路由地址
» componentbodystring前端组件
» selectedbodystring选中路径
» paramsbodystring路由参数
» is_cachebodystring是否缓存 0=否, 1=是
» is_showbodystring是否显示 0=否, 1=是
» is_disablebodyinteger是否禁用 0=否, 1=是

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 删除菜单

POST /adminapi/auth.menu/delete

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyintegerid

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 切换状态

POST /adminapi/auth.menu/updateStatus

  • 切换菜单状态

Body 请求参数

id: 0
is_disable: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyintegerid
» is_disablebodystring状态 0-正常 1-停用

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 菜单列表

GET /adminapi/auth.menu/lists

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": [
    {
      "id": 19,
      "pid": 0,
      "type": "M",
      "name": "系统设置",
      "icon": "icon_sort",
      "sort": 100,
      "perms": "",
      "paths": "setting",
      "component": "",
      "selected": "",
      "params": "",
      "is_cache": 0,
      "is_show": 1,
      "is_disable": 0,
      "create_time": "2022-04-20 10:41:03",
      "update_time": "2022-04-25 18:52:35",
      "children": []
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[object]truenonenone
»» idintegerfalsenonenone
»» pidintegerfalsenone父级id
»» typestringfalsenone类型: M=目录, C=菜单, A=按钮
»» namestringfalsenone名称
»» iconstringfalsenone图标
»» sortintegerfalsenone排序号 大到小
»» permsstringfalsenone权限链接
»» pathsstringfalsenonenone
»» componentstringfalsenone前端组件
»» selectedstringfalsenone选中路径
»» paramsstringfalsenone路由参数
»» is_cacheintegerfalsenone是否缓存 0=否, 1=是
»» is_showintegerfalsenone是否显示 0=否, 1=是
»» is_disableintegerfalsenone是否禁用 0=否, 1=是
»» create_timestringfalsenonenone
»» update_timestringfalsenonenone
»» children[string]falsenonenone

管理后台/系统设置/网站设置

GET 获取政策协议

GET /adminapi/setting.web.web_setting/getAgreement

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "service_title": 11,
    "service_content": 22,
    "privacy_title": 33,
    "privacy_content": 444
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» service_titleintegertruenone服务协议名称
»» service_contentintegertruenone服务协议内容
»» privacy_titleintegertruenone隐私政策名称
»» privacy_contentintegertruenone隐私政策内容

GET 获取网站信息

GET /adminapi/setting.web.web_setting/getWebsite

  • 设置网站信息

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "name": "likeshop平台",
    "web_favicon": "http://www.likeadmin.localhost/uploads/img.png",
    "web_logo": "http://www.likeadmin.localhost/img.png",
    "login_image": "http://www.likeadmin.localhost/img.png"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» namestringtruenone网站名称
»» web_faviconstringtruenone网站图标
»» web_logostringtruenone网站logo
»» login_imagestringtruenone登录页广告

POST 设置政策协议

POST /adminapi/setting.web.web_setting/setAgreement

Body 请求参数

service_title: string
service_content: string
privacy_title: string
privacy_content: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» service_titlebodystring服务协议名称
» service_contentbodystring服务协议内容
» privacy_titlebodystring隐私政策名称
» privacy_contentbodystring隐私政策内容

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "设置成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 设置网站信息

POST /adminapi/setting.web.web_setting/setWebsite

  • 网站信息

Body 请求参数

name: string
web_favicon: string
web_logo: string
login_image: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring网站名称
» web_faviconbodystring网站图标
» web_logobodystring网站logo
» login_imagebodystring登录页广告图

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "设置成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 设置备案信息

POST /adminapi/setting.web.web_setting/setCopyright

Body 请求参数

info: string
icp_number: string
icp_link: string
public_number: string
public_link: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» infobodystring版权信息
» icp_numberbodystringicp备案号
» icp_linkbodystringicp备案链接
» public_numberbodystring公安备案号
» public_linkbodystring公安备案链接

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "设置成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 获取备案信息

GET /adminapi/setting.web.web_setting/getCopyright

  • 设置备案信息

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "info": "版权信息",
    "icp_number": "icp备案号",
    "icp_link": "icp备案链接",
    "public_number": "公安备案号",
    "public_link": "公安备案链接"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

管理后台/系统设置/系统维护

GET 定时任务列表

GET /adminapi/crontab.crontab/lists

  • 获取定时任务列表

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 8,
        "name": "结算分销订单",
        "type": 1,
        "type_desc": "定时任务",
        "command": "distribution_settlement",
        "params": "123",
        "expression": "* * * * *",
        "status": 1,
        "status_desc": "运行",
        "error": null,
        "last_time": null,
        "time": "0",
        "max_time": "0"
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenone定时任务ID
»»» namestringfalsenone名称
»»» typeintegerfalsenone类型
»»» type_descstringfalsenone类型描述
»»» commandstringfalsenone命令
»»» paramsstringfalsenone参数
»»» expressionstringfalsenone运行规则
»»» statusintegerfalsenone状态
»»» status_descstringfalsenone状态描述
»»» errornullfalsenone错误信息
»»» last_timenullfalsenone最后执行时间
»»» timestringfalsenone执行时长
»»» max_timestringfalsenone最大执行时长
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

GET 获取个人信息

GET /adminapi/auth.admin/mySelf

  • 获取管理员信息

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "account": "admin",
    "name": "我是管理员",
    "role_id": 1,
    "disable": 0,
    "multipoint_login": 0,
    "avatar": "http://www.likeadmin.localhost/123123"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» accountstringtruenonenone
»» namestringtruenonenone
»» role_idintegertruenonenone
»» disableintegertruenonenone
»» multipoint_loginintegertruenonenone
»» avatarstringtruenonenone

GET 系统环境

GET /adminapi/setting.system.system/info

  • 获取系统环境

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "server": [
      {
        "param": "服务器操作系统",
        "value": "Linux"
      },
      {
        "param": "web服务器环境",
        "value": "nginx/1.17.0"
      },
      {
        "param": "PHP版本",
        "value": "8.0.6"
      }
    ],
    "env": [
      {
        "option": "PHP版本",
        "require": "8.0版本以上",
        "status": 1,
        "remark": ""
      }
    ],
    "auth": [
      {
        "dir": "/runtime",
        "require": "runtime目录可写",
        "status": 1,
        "remark": ""
      }
    ]
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» server[object]truenone服务器信息
»»» paramstringtruenonenone
»»» valuestringtruenonenone
»» env[object]truenonePHP环境要求
»»» optionstringfalsenonenone
»»» requirestringfalsenonenone
»»» statusintegerfalsenonenone
»»» remarkstringfalsenonenone
»» auth[object]truenone目录权限
»»» dirstringfalsenonenone
»»» requirestringfalsenonenone
»»» statusintegerfalsenonenone
»»» remarkstringfalsenonenone

POST 清除系统缓存

POST /adminapi/setting.system.cache/clear

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "清除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 添加定时任务

POST /adminapi/crontab.crontab/add

Body 请求参数

name: string
type: 0
command: string
expression: string
status: 0
remark: string
params: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring名称
» typebodyinteger类型
» commandbodystring命令
» expressionbodystring运行规则
» statusbodyinteger状态
» remarkbodystring备注
» paramsbodystring参数

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "添加成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 定时任务详情

GET /adminapi/crontab.crontab/detail

  • 查看定时任务详情

请求参数

名称位置类型必选说明
idqueryinteger定时任务ID

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "id": 1,
    "name": "定时任务1",
    "type": 1,
    "type_desc": "定时任务",
    "command": "test",
    "params": "",
    "status": 1,
    "status_desc": "运行",
    "expression": "0 23 * * *",
    "remark": "备注信息"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenone定时任务ID
»» namestringtruenone名称
»» typeintegertruenone类型
»» type_descstringtruenone类型描述
»» commandstringtruenone命令
»» paramsstringtruenone参数
»» statusintegertruenone状态
»» status_descstringtruenone状态描述
»» expressionstringtruenone运行规则
»» remarkstringtruenone备注

GET 获取规则执行时间

GET /adminapi/crontab.crontab/expression

请求参数

名称位置类型必选说明
expressionquerystring规则

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": [
    {
      "time": 1,
      "date": "2022-03-29 23:00:00"
    },
    {
      "time": 2,
      "date": "2022-03-30 23:00:00"
    },
    {
      "time": 3,
      "date": "2022-03-31 23:00:00"
    },
    {
      "time": 4,
      "date": "2022-04-01 23:00:00"
    },
    {
      "time": 5,
      "date": "2022-04-02 23:00:00"
    },
    {
      "time": "x",
      "date": "……"
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[object]truenonenone
»» timeintegertruenonenone
»» datestringtruenonenone

POST 编辑个人资料

POST /adminapi/auth.admin/editSelf

  • 编辑管理员信息

Body 请求参数

name: string
avatar: string
password_old: string
password: string
password_confirm: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring名称
» avatarbodystring头像
» password_oldbodystring当前密码(修改密码时必填)
» passwordbodystring新密码(修改密码时必填)
» password_confirmbodystring确认密码(修改密码时必填)

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 删除定时任务

POST /adminapi/crontab.crontab/delete

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyintegerid

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "删除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 编辑定时任务

POST /adminapi/crontab.crontab/edit

Body 请求参数

id: 0
name: string
type: 0
command: string
expression: string
status: 0
remark: string
params: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyintegerid
» namebodystring名称
» typebodyinteger类型
» commandbodystring命令
» expressionbodystring运行规则
» statusbodyinteger状态
» remarkbodystring备注
» paramsbodystring参数

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "编辑成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 系统日志

GET /adminapi/setting.system.log/lists

  • 获取系统日志列表

请求参数

名称位置类型必选说明
admin_namequerystring管理员
urlquerystring访问链接
ipquerystring来源IP
typequerystring访问方式
start_timequerystring日志时间开始
end_timequerystring日志时间结束

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 41,
        "action": " 查看菜单详情",
        "admin_name": "账号1",
        "admin_id": 1,
        "url": "http://www.likeshopb2cv3.localhost/adminapi/settings.system.log/lists?export=2",
        "type": "GET",
        "params": "{\"export\":\"2\"}",
        "ip": "172.18.0.1",
        "create_time": "2021-08-03 16:51:00"
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenone记录ID
»»» actionstringfalsenone操作名称
»»» admin_namestringfalsenone管理员
»»» admin_idintegerfalsenone管理员ID
»»» urlstringfalsenone访问链接
»»» typestringfalsenone访问方式
»»» paramsstringfalsenone访问参数
»»» ipstringfalsenone来源IP
»»» create_timestringfalsenone日志时间
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

管理后台/系统设置/用户设置

GET 获取用户设置

GET /adminapi/setting.user.user/getConfig

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "default_avatar": "11.png"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» default_avatarstringtruenone默认头像

POST 设置用户配置

POST /adminapi/setting.user.user/setConfig

Body 请求参数

default_avatar: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» default_avatarbodystring默认头像

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/系统设置/其他设置

POST 设置交易设置

POST /adminapi/setting.transaction_settings/setConfig

Body 请求参数

cancel_unpaid_orders: 0
cancel_unpaid_orders_times: 0
verification_orders: 0
verification_orders_times: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» cancel_unpaid_ordersbodyinteger是否开启:1-是;0-否
» cancel_unpaid_orders_timesbodyintegercancel_unpaid_orders为1时必填
» verification_ordersbodyinteger是否开启:1-是;0-否
» verification_orders_timesbodyintegerverification_orders为1时必填

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 获取交易设置

GET /adminapi/setting.transaction_settings/getConfig

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "cancel_unpaid_orders": 1,
    "cancel_unpaid_orders_times": 30,
    "verification_orders": 1,
    "verification_orders_times": 24
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» cancel_unpaid_ordersintegertruenone是否开启:1-是;0-否
»» cancel_unpaid_orders_timesintegertruenone自动取消未支付订单时间
»» verification_ordersintegertruenone是否开启:1-是;0-否
»» verification_orders_timesintegertruenone自动核销订单时间

POST 设置客服设置

POST /adminapi/setting.customer_service/setConfig

Body 请求参数

qr_code: string
wechat: string
phone: string
service_time: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» qr_codebodystring客服二维码
» wechatbodystring客服微信号
» phonebodystring客服手机号
» service_timebodystring服务时间

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "设置成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 获取客服设置

GET /adminapi/setting.customer_service/getConfig

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "qr_code": "http://www.smyy.localhost/111",
    "wechat": "fasdads",
    "phone": 17306643985,
    "service_time": "11:00-06:30"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» qr_codestringtruenone客服二维码
»» wechatstringtruenone客服微信号
»» phoneintegertruenone客服手机号
»» service_timestringtruenone服务时间

管理后台/系统设置/字典管理

GET 字典数据列表

GET /adminapi/setting.dict.dict_data/lists

请求参数

名称位置类型必选说明
namequerystring昵称
statusqueryinteger状态 0-停用 1-正常
type_idqueryinteger字典类型id
type_valuequerystring字典类型值

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 2,
        "name": "男",
        "value": "0",
        "type_id": 2,
        "type_value": "test_0",
        "sort": 0,
        "status": 1,
        "remark": "",
        "create_time": "2022-06-20 18:24:33",
        "update_time": "2022-06-20 18:24:33",
        "delete_time": null,
        "status_desc": "正常"
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenone数据id
»»» namestringfalsenone数据名称
»»» valuestringfalsenone数据值
»»» type_idintegerfalsenonenone
»»» type_valuestringfalsenone字典类型
»»» sortintegerfalsenone排序
»»» statusintegerfalsenone状态 0-停用 1-正常
»»» remarkstringfalsenone备注
»»» create_timestringfalsenonenone
»»» update_timestringfalsenonenone
»»» delete_timenullfalsenonenone
»»» status_descstringfalsenone状态描述
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

GET 字典类型列表

GET /adminapi/setting.dict.dict_type/lists

请求参数

名称位置类型必选说明
namequerystring字典名称
typequerystring字典类型
statusqueryinteger状态 0-停用 1-正常

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 3,
        "name": "类型111",
        "type": "test_1",
        "status": 1,
        "remark": "",
        "create_time": "2022-06-20 17:59:24",
        "update_time": "2022-06-20 17:59:24",
        "delete_time": null,
        "status_desc": "正常"
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenone字典id
»»» namestringfalsenone字典名称
»»» typestringfalsenone字典类型
»»» statusintegerfalsenone状态 0-停用 1-正常
»»» remarkstringfalsenone备注
»»» create_timestringfalsenonenone
»»» update_timestringfalsenonenone
»»» delete_timenullfalsenonenone
»»» status_descstringfalsenonenone
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

GET 获取字典数据详情

GET /adminapi/setting.dict.dict_data/detail

请求参数

名称位置类型必选说明
idqueryinteger数据id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "id": 2,
    "name": "男",
    "value": "0",
    "type_id": 2,
    "type_value": "test_0",
    "sort": 0,
    "status": 1,
    "remark": "",
    "create_time": "2022-06-20 18:24:33",
    "update_time": "2022-06-20 18:24:33",
    "delete_time": null
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenone数据id
»» namestringtruenone数据名称
»» valuestringtruenone数据值
»» type_idintegertruenonenone
»» type_valuestringtruenone字典类型
»» sortintegertruenone排序
»» statusintegertruenone状态 0-停用 1-正常
»» remarkstringtruenone备注
»» create_timestringtruenonenone
»» update_timestringtruenonenone
»» delete_timenulltruenonenone

POST 删除字典数据

POST /adminapi/setting.dict.dict_data/delete

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger数据id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "删除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 编辑字典数据

POST /adminapi/setting.dict.dict_data/edit

Body 请求参数

id: 0
name: string
value: string
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyintegerid
» namebodystring数据名称
» valuebodystring数据值
» statusbodyinteger状态 0-停用 1-正常

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "编辑成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 字典类型详情

GET /adminapi/setting.dict.dict_type/detail

  • 获取字典类型详情

请求参数

名称位置类型必选说明
idqueryintegerid

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "id": 2,
    "name": "类型00",
    "type": "test_0",
    "status": 0,
    "remark": "",
    "create_time": "2022-06-20 17:57:15",
    "update_time": "2022-06-20 17:57:15",
    "delete_time": null
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenone字典类型id
»» namestringtruenone字典名称
»» typestringtruenone字典类型
»» statusintegertruenone状态 0-停用 1-正常
»» remarkstringtruenonenone
»» create_timestringtruenonenone
»» update_timestringtruenonenone
»» delete_timenulltruenonenone

POST 添加字典数据

POST /adminapi/setting.dict.dict_data/add

Body 请求参数

name: string
value: string
type_id: 0
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring数据名称
» valuebodystring数据值
» type_idbodyinteger类型id
» statusbodyinteger状态 0-停用 1-正常

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "添加成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 编辑字典类型

POST /adminapi/setting.dict.dict_type/edit

  • 用户注册接口

Body 请求参数

id: 0
name: string
type: string
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger字典类型id
» namebodystring名称
» typebodystring类型
» statusbodyinteger状态 0-停用 1-正常

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "编辑成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 删除字典类型

POST /adminapi/setting.dict.dict_type/delete

  • 用户注册接口

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger类型id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "删除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 添加字典类型

POST /adminapi/setting.dict.dict_type/add

Body 请求参数

name: string
type: string
status: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» namebodystring名称
» typebodystring类型
» statusbodyinteger状态 0-停用 1-正常

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "添加成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/文件/文件分类

GET 分类列表

GET /adminapi/file/listCate

请求参数

名称位置类型必选说明
typequeryinteger类型: 10=图片,20=视频,30=文件

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 1,
        "pid": 0,
        "type": 10,
        "name": "顶级文件分类",
        "children": [
          {
            "id": 2,
            "pid": 1,
            "type": 10,
            "name": "分类1"
          }
        ]
      }
    ],
    "count": 2,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenoneid
»»» pidintegerfalsenone上级id
»»» typeintegerfalsenone类型
»»» namestringfalsenone名称
»»» children[object]falsenone下级分类
»»»» idintegerfalsenonenone
»»»» pidintegerfalsenonenone
»»»» typeintegerfalsenonenone
»»»» namestringfalsenonenone
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

POST 添加分类

POST /adminapi/file/addCate

Body 请求参数

type: string
pid: 0
name: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» typebodystring类型: 10=图片,20=视频,30=文件
» pidbodyinteger父级 0=顶级
» namebodystring分类的名称

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "添加成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 编辑分类

POST /adminapi/file/editCate

Body 请求参数

id: 0
name: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger分类id
» namebodystring分类名称

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "编辑成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 删除分类

POST /adminapi/file/delCate

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger分类id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "删除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

管理后台/文件/文件操作

POST 删除文件

POST /adminapi/file/delete

Body 请求参数

ids: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idsbodystring需要删除的文件 id数组

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "删除成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 移动文件

POST /adminapi/file/move

Body 请求参数

ids: string
cid: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idsbodystring需要移动的文件 id数组
» cidbodyinteger需要移动到哪个分类id下

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "移动成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 重命名文件

POST /adminapi/file/rename

Body 请求参数

id: 0
name: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger文件id
» namebodystring文件名称

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "重命名成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 文件列表

GET /adminapi/file/lists

请求参数

名称位置类型必选说明
namequerystring文件名称
typequeryinteger文件类型: 10=图片;20=视频;30=文件
cidqueryinteger类目,不填写则获取全部

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 149,
        "cid": 0,
        "type": 40,
        "name": "19b3c7c187b4611e87ef780e0c0a5f01.pem",
        "uri": "http://www.likv3.localhost/72619.pem"
      }
    ],
    "count": 6,
    "page_no": 1,
    "page_size": 25
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenoneid
»»» cidintegerfalsenone分类id
»»» typeintegerfalsenone文件类型;10=图片;20=视频;30=文件
»»» namestringfalsenone文件名称
»»» uristringfalsenoneuri
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone

管理后台/存储引擎

GET 列表

GET /adminapi/setting.storage/lists

  • 获取存储引擎列表

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "获取成功",
  "data": [
    {
      "name": "本地存储",
      "path": "存储在本地服务器",
      "engine": "local",
      "status": 1
    },
    {
      "name": "七牛云存储",
      "path": "存储在七牛云,请前往七牛云开通存储服务",
      "engine": "qiniu",
      "status": 0
    },
    {
      "name": "阿里云OSS",
      "path": "存储在阿里云,请前往阿里云开通存储服务",
      "engine": "aliyun",
      "status": 0
    },
    {
      "name": "腾讯云OSS",
      "path": "存储在腾讯云,请前往腾讯云开通存储服务",
      "engine": "qcloud",
      "status": 0
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[object]truenonenone
»» namestringtruenonenone
»» pathstringtruenonenone
»» enginestringtruenonenone
»» statusintegertruenonenone

管理后台/开发工具/代码生成器

POST 选择数据表

POST /adminapi/tools.generator/selectTable

  • 选择要生成代码的数据表

Body 请求参数

table: string
--name: string
--comment: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» tablebodystring数据表信息
» --namebodystring数据表名称
» --commentbodystring数据表描述

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "添加成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 已选数据表详情

GET /adminapi/tools.generator/detail

  • 已选择的数据表详情

请求参数

名称位置类型必选说明
idqueryinteger记录id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "id": 16,
    "table_name": "ls_admin",
    "table_comment": "管理员表213",
    "template_type": 0,
    "author": "",
    "remark": "",
    "generate_type": 0,
    "module_name": "adminapi",
    "class_dir": "",
    "class_comment": "",
    "create_time": "2022-06-15 09:44:58",
    "update_time": "2022-06-15 09:44:58",
    "delete_time": null,
    "table_column": [
      {
        "id": 40,
        "table_id": 16,
        "column_name": "id",
        "column_comment": "",
        "column_type": "int",
        "is_required": 0,
        "is_pk": 1,
        "is_insert": 0,
        "is_update": 0,
        "is_lists": null,
        "is_query": null,
        "query_type": "=",
        "view_type": "text",
        "create_time": "2022-06-15 09:44:58",
        "update_time": "2022-06-15 09:44:58",
        "delete_time": null
      }
    ],
    "menu": {
      "pid": 11,
      "name": "测试",
      "type": 0
    }
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» idintegertruenone记录id
»» table_namestringtruenone表名称
»» table_commentstringtruenone表描述
»» template_typeintegertruenone模板类型 0-单表(curd) 1-树表(curd)
»» authorstringtruenone作者
»» remarkstringtruenone备注
»» generate_typeintegertruenone生成方式 0-压缩包下载 1-生成到模块
»» module_namestringtruenone模块名
»» class_dirstringtruenone类目录名
»» class_commentstringtruenone类描述
»» create_timestringtruenonenone
»» update_timestringtruenonenone
»» delete_timenulltruenonenone
»» table_column[object]truenonenone
»»» idintegerfalsenone记录id
»»» table_idintegerfalsenonenone
»»» column_namestringfalsenonenone
»»» column_commentstringfalsenonenone
»»» column_typestringfalsenonenone
»»» is_requiredintegerfalsenonenone
»»» is_pkintegerfalsenonenone
»»» is_insertintegerfalsenonenone
»»» is_updateintegerfalsenonenone
»»» is_listsnullfalsenonenone
»»» is_querynullfalsenonenone
»»» query_typestringfalsenonenone
»»» view_typestringfalsenonenone
»»» create_timestringfalsenonenone
»»» update_timestringfalsenonenone
»»» delete_timenullfalsenonenone
»» menuobjecttruenone菜单配置
»»» pidintegertruenonenone
»»» namestringtruenonenone
»»» typeintegertruenonenone

POST 预览代码

POST /adminapi/tools.generator/preview

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger表id

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": [
    {
      "name": "test.php",
      "type": "php",
      "content": "见接口"
    }
  ]
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[object]truenonenone
»» namestringfalsenone文件名称
»» typestringfalsenone文件类型
»» contentstringfalsenone文件内容

POST 下载压缩包

POST /adminapi/tools.generator/download

Body 请求参数

file: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» filebodystring压缩包名称

返回示例

成功

null

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

POST 生成代码

POST /adminapi/tools.generator/generate

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger需生成代码的表id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": {
    "file": "http://www.likeadmin.localhost/adminapi/tools.generator/download?file=curd-20220624115537.zip"
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» filestringtruenone压缩包名称

POST 同步字段

POST /adminapi/tools.generator/syncColumn

Body 请求参数

id: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger已选数据表id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

GET 已选数据表列表

GET /adminapi/tools.generator/generateTable

  • 代码生成已选数据表列表接口

请求参数

名称位置类型必选说明
table_namequerystring表名称
table_commentquerystring表描述

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "id": 1,
        "table_name": "test",
        "table_comment": "test描述",
        "template_type": 0,
        "author": "哈哈",
        "remark": "",
        "generate_type": 0,
        "module_name": "adminapi",
        "class_name": "",
        "class_comment": null,
        "create_time": "2022-04-02 09:36:51",
        "update_time": null,
        "delete_time": null,
        "template_type_desc": "单表(增删改查)"
      }
    ],
    "count": 1,
    "page_no": 1,
    "page_size": 25,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» idintegerfalsenoneid
»»» table_namestringfalsenone表名称
»»» table_commentstringfalsenone表描述
»»» template_typeintegerfalsenonenone
»»» authorstringfalsenonenone
»»» remarkstringfalsenonenone
»»» generate_typeintegerfalsenonenone
»»» module_namestringfalsenonenone
»»» class_namestringfalsenonenone
»»» class_commentnullfalsenonenone
»»» create_timestringfalsenone创建时间
»»» update_timenullfalsenone更新时间
»»» delete_timenullfalsenonenone
»»» template_type_descstringfalsenone模板类型
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

GET 数据表列表

GET /adminapi/tools.generator/dataTable

  • 数据表列表接口

请求参数

名称位置类型必选说明
namequerystring表名称
commentquerystring表描述

返回示例

成功

{
  "code": 1,
  "show": 0,
  "msg": "",
  "data": {
    "lists": [
      {
        "name": "ls_ad",
        "engine": "InnoDB",
        "version": 10,
        "row_format": "Dynamic",
        "rows": 2,
        "avg_row_length": 8192,
        "data_length": 16384,
        "max_data_length": 0,
        "index_length": 0,
        "data_free": 0,
        "auto_increment": 3,
        "create_time": "2022-03-29 09:38:13",
        "update_time": null,
        "check_time": null,
        "collation": "utf8mb4_general_ci",
        "checksum": null,
        "create_options": "",
        "comment": "广告表"
      }
    ],
    "count": 21,
    "page_no": 1,
    "page_size": 1,
    "extend": []
  }
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» lists[object]truenonenone
»»» namestringfalsenone表名称
»»» enginestringfalsenonenone
»»» versionintegerfalsenonenone
»»» row_formatstringfalsenonenone
»»» rowsintegerfalsenonenone
»»» avg_row_lengthintegerfalsenonenone
»»» data_lengthintegerfalsenonenone
»»» max_data_lengthintegerfalsenonenone
»»» index_lengthintegerfalsenonenone
»»» data_freeintegerfalsenonenone
»»» auto_incrementintegerfalsenonenone
»»» create_timestringfalsenone创建时间
»»» update_timenullfalsenonenone
»»» check_timenullfalsenonenone
»»» collationstringfalsenonenone
»»» checksumnullfalsenonenone
»»» create_optionsstringfalsenonenone
»»» commentstringfalsenone表描述
»» countintegertruenonenone
»» page_nointegertruenonenone
»» page_sizeintegertruenonenone
»» extend[string]truenonenone

POST 删除已选数据表

POST /adminapi/tools.generator/delete

  • 删除已选择的数据表

Body 请求参数

id: string

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodystring已选数据表id

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

POST 编辑已选表字段

POST /adminapi/tools.generator/edit

Body 请求参数

id: 0
table_name: string
table_comment: string
template_type: 0
author: string
remark: string
generate_type: 0
module_name: string
class_dir: string
class_comment: string
table_column: string
--id: 0
--column_comment: 0
--is_required: 0
--is_insert: 0
--is_update: 0
--is_lists: 0
--is_query: 0
--query_type: string
--view_type: string
--dict_type: string
menu: string
--pid: 0
--name: string
--type: 0

请求参数

名称位置类型必选说明
bodybodyobjectnone
» idbodyinteger表id
» table_namebodystring表名称
» table_commentbodystring表描述
» template_typebodyinteger模板类型 0-单表(curd) 1-树表(curd)
» authorbodystring作者
» remarkbodystring备注
» generate_typebodyinteger生成方式 0-压缩包下载 1-生成到模块
» module_namebodystring模块名
» class_dirbodystring类目录名
» class_commentbodystring类描述
» table_columnbodystring表字段
» --idbodyinteger表字段id
» --column_commentbodyinteger字段描述
» --is_requiredbodyinteger是否必填 0-非必填 1-必填
» --is_insertbodyinteger是否为插入字段 0-不是 1-是
» --is_updatebodyinteger是否为更新字段 0-不是 1-是
» --is_listsbodyinteger是否为列表字段 0-不是 1-是
» --is_querybodyinteger是否为查询字段 0-不是 1-是
» --query_typebodystring查询类型
» --view_typebodystring显示类型
» --dict_typebodystring字典类型
» menubodystring菜单配置
» --pidbodyinteger上级菜单配置
» --namebodystring菜单名称
» --typebodyinteger菜单类型 0-手动构建 1-自动构建

返回示例

成功

{
  "code": 1,
  "show": 1,
  "msg": "操作成功",
  "data": []
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new window成功Inline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» showintegertruenonenone
» msgstringtruenonenone
» data[string]truenonenone

数据模型

上次更新:
贡献者: lr