跳到主要内容

OpenAPI 插件手册

OpenAPI 插件模块用于管理外部 API 接入能力,并通过插件与插件工具的形式提供统一的调用入口。

入口

在左侧导航中,选择 资源 > 插件

页面概览

OpenAPI 插件页面

OpenAPI 插件页面首页用于统一维护插件资源。页面上方提供操作说明区,帮助用户快速了解插件维护、插件查看与后续接入场景;说明区下方提供 插件开发插件广场 两个页签。

插件开发 页签中,顶部筛选区支持按以下条件查询插件:

  • 范围:用于切换当前查询的资源范围。
  • 认证方式:用于按插件认证类型筛选。
  • 公开类型:用于区分跨租户、租户内与私有插件。
  • 状态:用于区分正常与删除状态。
  • 关键字:用于按插件名称快速检索。

筛选区下方提供 新增 OpenAPI 插件 入口。创建插件后,可以继续进入对应插件维护工具定义与联调测试内容。

插件广场

OpenAPI 插件广场页签

插件广场 页签中,可以浏览当前可见范围内的插件资源。该页签适合用于跨范围查找已有插件,并在确认插件信息后进入详情查看。

当前页签顶部支持以下筛选方式:

  • 租户:用于切换插件归属租户。
  • 范围:用于切换全部、租户、个人或业务域范围。
  • 业务域:当范围切换到业务域时,用于进一步限定业务域节点。
  • 认证方式公开类型:用于缩小候选插件范围。
  • 关键字搜索:用于按名称快速定位目标插件。

新增 OpenAPI 插件弹窗

新增 OpenAPI 插件弹窗

插件开发 页签中点击 新增 OpenAPI 插件 后,会打开新增弹窗。该弹窗用于一次性完成插件基础信息、认证方式与默认请求头配置。

当前弹窗包含以下关键字段:

  • 范围:支持租户、业务域、个人三类范围。
  • 公开类型:支持跨租户、租户内、私有三种公开口径。
  • 插件名称:用于标识插件资源。
  • 基础 URL:用于填写目标 API 的域名或根路径。
  • 状态:用于控制插件是否处于正常状态。
  • Logo / 图标:支持填写图标名称、图片地址或直接上传图片。
  • 插件描述:用于补充用途、适用场景与边界说明。
  • Header 列表:用于预置默认请求头。
  • 认证方式:用于选择不需要授权、API Key、OAuth 标准或 OIDC 方式。
  • 备注说明:用于补充参数约束、错误语义或其他维护说明。

弹窗底部提供 取消新增插件 操作,保存成功后即可回到插件列表继续维护。

功能概览

OpenAPI 插件页面通常用于承载以下操作:

  • 浏览和筛选插件资源
  • 查看插件下的工具定义
  • 维护插件及插件工具配置
  • 执行页面提供的测试与管理操作

使用建议

配置插件前,建议先确认目标接口的访问地址、认证方式、请求参数和可见范围,再进入页面完成维护。

相关页面