通过 JSON 或 YAML 文件导入插件

本文介绍如何通过导入定义 API 的 JSON 或 YAML 文件来创建插件。创建插件后，必须发布插件才可以被 Bot 使用。 ​

🎈

•
在个人空间下创建的插件，仅能被个人调用。 ​

•
在团队空间下创建的插件，能被团队成员调用。 ​

•
插件发布了新版本后，使用了这个插件的 Bot 会自动使用发布的最新版本。 ​

•

定义 API 的 JSON 或 YAML 文件仅支持 OpenAPI、Swagger 或 Postman Collection 协议。

操作步骤

3.
在页面顶部进入插件页面，并在右上角单击导入。 ​

common.docs_name - LarkCCM_Docs_Menu_Image

另外支持在存量的插件详情页内导入工具。您需要进入插件详情页，在工具列表右上角单击导入。 ​

4.
在导入插件对话框，选择以下任一导入方式，并单击下一步。 ​
◦
方式一：在本地文件页签内，通过拖拽或点击的方式，上传保存在本地的 JSON 或 YAML 文件。 ​
◦
方式二：在 URL 和原始数据页签内，填写存放 API JSON 或 YAML 文件的 URL 地址。 ​
◦
方式三：在 URL 和原始数据页签内，填写 JSON 或 YAML 格式的 API 原始数据。 ​

🎈

如果您需要单次导入多个 API，则需要确保各个 API 有相同的 URL 路径前缀，该路径前缀将会作为插件 URL 来使用。如果单次导入的 API URL 路径前缀不一致，则会导入失败。 ​

5.
导入后，在确认插件信息对话框，补全插件配置信息，并单击确认。 ​

配置项说明：

配置项	说明
插件图标	单击默认图标后，您可以上传本地图片文件作为新的图标。
插件名称	自定义插件名称，用于标识当前插件。建议输入清晰易理解的名称，便于大语言模型搜索与使用插件。
插件描述	插件的描述信息，一般用于记录当前插件的用途。
插件 URL	插件的访问地址或相关资源的链接，不可修改，示例值 https://www.example.com/api。如果一次导入了多个 API，则这里的插件 URL 是指各个 API 中相同的 URL 路径前缀。
Header 列表	HTTP 请求头参数列表。
授权方式	选择插件内 API 的鉴权方式。目前支持以下三种： • 不需要授权 • Service：服务认证，该认证方式是指 API 通过秘钥或令牌校验合法性。 ◦ 位置：选择秘钥或令牌的传递位置，Header（请求头）或是 Query （查询参数）内。 ◦ Parameter name：秘钥或令牌对应的参数名称。 ◦ Service token / API key：秘钥或令牌的值。后续根据该值进行服务认证。 • Oauth > standard：OAuth 是一种常用于用户代理身份验证的标准，它允许第三方应用程序在不共享用户密码的情况下访问用户下的特定资源。 ◦ client_id：注册 OAuth 后获取的唯一标识符。 ◦ client_secret：与 client_id 匹配的密码。 ◦ client_url：验证通过后，模型会重定向到该 url。 ◦ scope：您的应用需要访问的资源范围或级别。 ◦ authorization_url：OAuth 提供商的 URL，用户会重定向到该 URL 进行应用授权。 ◦ authorization_content_type：向 OAuth 提供商发送数据时的内容类型。

通过 JSON 或 YAML 文件导入插件​

通过 JSON 或 YAML 文件导入插件