插件管理

已安装插件的信息、迁移记录与启停管理。

插件分页列表

接口地址

GET /admin/plugin/list

接口参数说明

Query 参数	类型	必填	说明
keyword	string	否	插件名称或标识关键字
status	integer	否	插件状态 1启用 2停用
page	integer	否	页码，默认 1
page_size	integer	否	每页数量，默认 20，最大 100

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "id": 1,
        "created_at": "2026-09-25T10:00:00+08:00",
        "updated_at": "2026-09-25T10:00:00+08:00",
        "plugin_id": "",
        "name": "",
        "version": "",
        "code_version": "",
        "logo": "",
        "logo_url": "",
        "author": "",
        "homepage": "",
        "description": "",
        "status": 1,
        "compiled": false
      }
    ],
    "total": 0
  }
}

响应参数说明

响应字段	类型	说明
list	array<PluginItem>
list[].id	integer	主键ID
list[].created_at	string	创建时间
list[].updated_at	string	更新时间
list[].plugin_id	string	插件唯一标识
list[].name	string	插件名称
list[].version	string	数据库安装版本
list[].code_version	string	当前程序编译版本，未编译时为空
list[].logo	string	插件Logo相对路径
list[].logo_url	string	根据当前存储配置补全的插件Logo访问地址
list[].author	string	插件作者
list[].homepage	string	插件主页地址
list[].description	string	插件描述
list[].status	integer	插件状态 1启用 2停用
list[].compiled	boolean	是否编译进当前程序
total	integer	数据总数

插件详情及迁移记录

接口地址

GET /admin/plugin/detail

接口参数说明

Query 参数	类型	必填	说明
plugin_id	string	是	插件唯一标识

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "manifest": "",
    "migrations": [
      {
        "id": 0,
        "version": "",
        "checksum": "",
        "status": 1,
        "execution_ms": 0,
        "error_message": "",
        "executed_at": "2026-09-25T10:00:00+08:00"
      }
    ]
  }
}

响应参数说明

响应字段	类型	说明
manifest	string	安装时插件清单JSON快照
migrations	array<PluginMigrationItem>	数据库迁移记录
migrations[].id	integer	主键ID
migrations[].version	string	迁移版本
migrations[].checksum	string	迁移内容SHA256摘要
migrations[].status	integer	迁移状态 1成功 2失败
migrations[].execution_ms	integer	执行耗时毫秒
migrations[].error_message	string	失败原因
migrations[].executed_at	string	执行时间

修改插件启停状态

接口地址

POST /admin/plugin/status

接口说明

修改数据库状态，管理端 API 和用户端 API 重启后生效。启用前校验编译版本、迁移及依赖，停用前校验反向依赖。

接口参数说明

Body 参数	类型	必填	说明
plugin_id	string	是	插件唯一标识
status	integer	是	插件状态 1启用 2停用

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "code": 0,
    "msg": "success",
    "data": null
  }
}

响应参数说明

成功时 data 为 null。

修改插件展示信息

接口地址

POST /admin/plugin/info

接口说明

只维护插件作者、插件主页和描述，不修改插件标识、版本及运行清单。

接口参数说明

Body 参数	类型	必填	说明
plugin_id	string	是	插件唯一标识
logo	string	否	插件Logo相对路径，也兼容当前存储域名下的完整地址
author	string	否	插件作者
homepage	string	否	插件主页地址
description	string	否	插件描述

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "code": 0,
    "msg": "success",
    "data": null
  }
}

响应参数说明

成功时 data 为 null。