API文档

插件

插件系统 API
插件系统目前处于开发阶段,接口和功能可能会有较大变动。

获取已通过审核的插件列表

GET/plugins

获取所有已通过审核的插件,按点赞数和更新时间排序,支持分页。

查询参数:

page
string
页码,从 1 开始
limit
string
每页数量,1-100

说明:

  • 响应使用统一 ApiResponse 包裹。
  • status 字段实际为小写:pending / approved / rejected
  • 列表项包含 type 字段(如 HTTPKNOWLEDGE_SEARCH)。

响应状态码:

状态码说明
200获取成功
400分页参数无效

搜索插件

GET/plugins/search

按名称或描述模糊搜索已通过审核的插件。

查询参数:

q
string
搜索关键词(可选)
page
string
页码,从 1 开始
limit
string
每页数量,1-100

响应状态码:

状态码说明
200搜索成功
400查询参数无效

获取插件详情

GET/plugins/{pluginId}

获取指定插件详情(仅返回已通过审核插件)。

说明:

  • 与列表相比,详情返回 executionConfig,而不是 code
  • 未审核通过的插件对外等价为 404

响应状态码:

状态码说明
200获取成功
404插件不存在或未通过审核

创建插件

POST/plugins Auth

创建新插件,初始状态为待审核。

请求参数:

name
string required
插件名称
description
string required
插件描述
version
string required
版本号
schema
object required
插件 schema,包含 namedescriptionparameters
executionConfig
object required
插件执行配置(按插件类型)

响应状态码:

状态码说明
200创建成功
400输入参数无效
401未登录或令牌无效

更新插件

PUT/plugins/{pluginId} Auth

更新指定插件信息,仅作者可操作。

请求参数:

name
string required
插件名称
description
string required
插件描述
version
string required
版本号
schema
object required
插件 schema
executionConfig
object required
插件执行配置

响应状态码:

状态码说明
200更新成功
400输入参数无效
401未登录或令牌无效
403无权操作
404插件不存在

删除插件

DELETE/plugins/{pluginId} Auth

删除指定插件,仅作者可操作。

响应状态码:

状态码说明
204删除成功
401未登录或令牌无效
403无权操作
404插件不存在

获取我的插件

GET/me/plugins Auth

获取当前用户创建的所有插件,支持分页。

查询参数:

page
string
页码,从 1 开始
limit
string
每页数量,1-100

响应状态码:

状态码说明
200获取成功
400分页参数无效
401未登录或令牌无效

点赞插件

POST/plugins/{pluginId}/like Auth

为指定插件点赞。

响应状态码:

状态码说明
200点赞成功
401未登录或令牌无效
404插件不存在
409已经点赞过

取消点赞

DELETE/plugins/{pluginId}/like Auth

取消对指定插件的点赞。

响应状态码:

状态码说明
204取消成功
401未登录或令牌无效
404插件不存在或点赞记录不存在

审批通过插件

POST/plugins/{pluginId}/approve Auth

将指定插件状态设为已通过(需要管理员权限)。

响应状态码:

状态码说明
200审批成功
401未登录或令牌无效
403需要管理员权限
404插件不存在
409当前状态不允许审批通过

审批拒绝插件

POST/plugins/{pluginId}/reject Auth

将指定插件状态设为已拒绝(需要管理员权限)。

响应状态码:

状态码说明
200审批成功
401未登录或令牌无效
403需要管理员权限
404插件不存在
409当前状态不允许审批拒绝

获取待审核插件列表

GET/admin/plugins/pending Auth

获取所有待审核插件(需要管理员权限),支持分页。

查询参数:

page
string
页码,从 1 开始
limit
string
每页数量,1-100

响应状态码:

状态码说明
200获取成功
400分页参数无效
401未登录或令牌无效
403需要管理员权限