更新时间:2023-03-01 GMT+08:00

使用插件

概述

ROMA Connect支持通过插件的方式,为API提供灵活的扩展能力。

前提条件

  • 插件和API本身相互独立,只有为API绑定插件后,插件才对API生效。为API绑定插件时需指定发布环境,插件只对指定环境上的API生效。
  • 同一个API在同一个环境中只能绑定一个相同类型的插件。
  • 已被API绑定的插件无法删除。

创建插件

  1. 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
  2. 在左侧的导航栏选择“服务集成 APIC > API管理”,在“插件”页签下单击“创建插件”。
  3. 在创建插件弹窗中配置插件信息。
    表1 插件配置

    参数

    配置说明

    插件名称

    填写插件的名称,根据规划自定义。建议您按照一定的命名规则填写插件名称,方便您快速识别和查找。

    插件类型

    选择插件的类型,不同类型的插件提供不同扩展能力。

    • 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。
    • Kafka日志推送:提供了把API的详细调用日志推送到Kafka的能力。
    • HTTP响应头管理:提供了自定义HTTP响应头的能力,并在API响应中返回自定义的响应头。
    • 断路器:在后端服务出现性能问题时为系统提供保护的能力。

    可见范围

    选择插件的可见范围。

    • 集成应用:插件归属某个集成应用,仅拥有该集成应用权限的用户可查看和使用该插件。
    • 全局:所有用户都可查看和使用该插件。

    集成应用

    仅当“可见范围”选择“集成应用”时需要配置。

    选择插件所属的集成应用。若没有可用的集成应用,可单击右侧的“新建集成应用”,创建一个集成应用。

    描述

    填写插件的描述信息。

    插件内容

    插件的配置内容,支持表单配置和脚本配置两种方式。

    根据不同的插件类型,插件内容的配置不同:

  4. 单击“确定”,完成插件的创建。

    插件创建后,您还需要为API绑定插件,才能使插件对API生效。

为API绑定插件

  1. 在实例控制台左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签下单击要绑定插件的API名称,进入API详情页面。
  2. 在“插件”页签下,单击“绑定插件”。
  3. 在绑定插件弹窗中,选择要绑定插件的“环境”和要绑定的“插件类型”,然后选中要绑定的插件。

    您可以通过插件名称搜索所需的插件。

  4. 单击“确定”,完成API与插件的绑定。