Home > ISYS_ExternalApiHelp

ISYS_ExternalApiHelp interface

扩展注入的上层接口 Help 元数据

Signature

interface ISYS_ExternalApiHelp

Remarks

注册 external 接口时可附带本元数据，供 Help 框架渐进式披露； AI 可通过 eda.sys_Help.help('external', namespace, apiName) 查询

Properties

Property	Modifiers	Type	Description
description?		string	(Optional) 详细说明
example?		string	(Optional) 使用示例
params?		Array<{ name: string; type?: string; description?: string; required?: boolean }>	(Optional) 入参说明
returns?		{ type?: string; description?: string }	(Optional) 返回值说明
title?		string	(Optional) 接口标题