执行插件

接口信息

接口地址:/api/v1/plugin/{id}/execute

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

运行指定的插件，请求体为动态参数，根据插件定义的入参传递

请求示例:

javascript

{
  "query": "test",
  "count": 5
}

请求参数

请求头

参数名	类型	必填	描述	示例值
Authorization	string	是	API Key	`Bearer ak-xxxxeyJhbGciOiJIUzI1NiJ9`

路径参数:

参数名称	参数说明	是否必须	数据类型
id	插件ID	是	integer(int64)

请求体参数:

动态参数，根据插件定义的入参传递对应的 key-value 键值对。

响应参数:

参数名称	参数说明	类型
code	业务状态码，0000 表示成功，其余失败	string
displayCode	源系统状态码，用于问题跟踪	string
message	错误描述信息	string
data	插件执行返回的结果	object
tid	跟踪唯一标识	string
success		boolean

响应示例:

javascript

{
	"code": "0000",
	"displayCode": "0000",
	"message": "success",
	"data": null,
	"tid": "3103671776084713674",
	"success": true
}

CURL示例

shell

curl 'http://127.0.0.1:8081/api/v1/plugin/100/execute' \
  -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer ak-d1f2129c4ba24629b8448af3354f9dd0' \
  --data-raw '{"query": "test", "count": 5}'

{"code":"0000","displayCode":"0000","message":"success","data":null,"tid":"1559721776084718811","success":true}

测试用例

#	场景	状态码	结果
1	执行已发布的插件	0000	成功，返回插件执行结果
2	执行不存在或未发布的插件	0001	失败，提示"Error plugin id or not published"

TS模板示例

// 响应接口
export interface PluginExecuteRes {
  code: string;
  displayCode: string;
  message: string;
  data: object | null;
  tid: string;
  success: boolean;
}

/** 
 * 执行插件
 * @param {number} id - 插件ID
 * @param {Record<string, unknown>} params - 插件动态入参
 * @returns
 */
export function executePlugin(id: number, params: Record<string, unknown>): Promise<PluginExecuteRes> {
  return request.post(`/api/v1/plugin/${id}/execute`, params);
}

执行插件 ​

接口信息 ​

请求参数 ​

执行插件

接口信息

请求参数