Files
full/module/base/mgt/doc/app.md

3.9 KiB
Raw Blame History

应用模块接口文档

基础路径:POST /mgt/app/*,需 JWT 认证。


1. 新增应用

路径:POST /mgt/app/create

请求体(ApplicationRequest):

参数 类型 必填 说明
title string 否 应用名称,1-200 位
workspace string 否 工作空间标识,1-100 位,与 title 至少填其一
description string 否 描述,最长 1000
page number 否 分页用
size number 否 分页用
keyword string 否 关键字
status number 否 状态

请求示例:

{
  "title": "后台管理系统",
  "workspace": "admin_console",
  "description": "运营与配置管理"
}

返回(IdResp):

{
  "code": 0,
  "data": {
    "id": 1,
    "identity": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
  }
}

2. 删除应用

路径:POST /mgt/app/del

请求体:

参数 类型 必填 说明
id number 是 应用 ID

请求示例:

{
  "id": 1
}

返回示例:

{
  "code": 0,
  "data": {
    "id": 1,
    "identity": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
  }
}

3. 应用详情

路径:POST /mgt/app/detail

请求体:

参数 类型 必填 说明
id number 是 应用 ID

请求示例:

{
  "id": 1
}

返回(ApplicationRsp):

参数 类型 说明
id number 应用 ID
identity string 唯一标识
title string 应用名称
code string 编码(与 workspace 对应)
description string 描述
created_at string 创建时间

返回示例:

{
  "code": 0,
  "data": {
    "id": 1,
    "identity": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "title": "后台管理系统",
    "code": "admin_console",
    "description": "运营与配置管理",
    "created_at": "2025-03-16 10:00:00"
  }
}

4. 修改应用

路径:POST /mgt/app/modify

请求体:

参数 类型 必填 说明
id number 是 应用 ID
title string 否 应用名称
workspace string 否 工作空间标识
description string 否 描述
status number 否 状态

请求示例:

{
  "id": 1,
  "title": "运营后台",
  "description": "运营与配置管理 v2"
}

返回示例:

{
  "code": 0,
  "data": {
    "id": 1,
    "identity": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
  }
}

5. 获取应用列表(分页)

路径:POST /mgt/app/fetch

请求体:

参数 类型 必填 说明
page number 否 页码
size number 否 每页条数
keyword string 否 关键字,模糊匹配 title/code
status number 否 状态

请求示例:

{
  "page": 1,
  "size": 10,
  "keyword": "后台",
  "status": 1
}

返回(FetchResp,data 为 ApplicationRsp 数组):

{
  "code": 0,
  "data": {
    "total": 1,
    "page": 1,
    "size": 10,
    "data": [
      {
        "id": 1,
        "identity": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "title": "后台管理系统",
        "code": "admin_console",
        "description": "运营与配置管理",
        "created_at": "2025-03-16 10:00:00"
      }
    ]
  }
}

6. 获取应用用户列表

路径:POST /mgt/app/user

请求体:FetchBase,id 为应用 ID。

请求示例:

{
  "id": 1
}

返回:data 为该应用下的用户列表。


7. 获取应用角色列表

路径:POST /mgt/app/role

请求体:同上,id 为应用 ID。


8. 获取应用权限列表

路径:POST /mgt/app/pmn

请求体:同上,id 为应用 ID。

返回:data 为该应用下的权限列表。