API网关 APIGAPI网关 APIG

更新时间:2021/09/26 GMT+08:00
分享

创建插件

API网关专享版支持通过插件的方式,为API提供灵活的扩展能力。

前提条件

  • 一个API只能绑定一个相同类型的插件。
  • 插件和API本身相互独立,只有为API绑定插件后,插件才对API生效。为API绑定插件时需指定发布环境,插件只对指定环境上的API生效。
  • 插件的绑定、解绑、更新会实时生效,不需要重新发布API。
  • API的下线操作不影响插件的绑定关系,再次发布后仍然会带有下线前绑定的插件。
  • 如果插件与API有绑定关系,则插件无法执行删除操作。

创建插件

  1. 登录管理控制台。
  2. 在管理控制台左上角单击,选择区域。
  3. 单击管理控制台左上角,然后单击“API网关 APIG”。
  4. 在左侧导航单击“专享版”,进入专享版实例列表页,单击“查看控制台”,进入API开发与调用管理页面。
  5. 单击“开放API > 插件”,进入到插件列表页面。
  6. 单击“创建插件”。

    在创建插件弹窗中配置插件信息。

    表1 插件配置

    参数

    配置说明

    插件名称

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

    插件类型

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

    • 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。
    • HTTP响应头管理插件:可以自定义HTTP响应头,在返回的API响应中指定配置的响应头。

    插件内容

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

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

    描述

    填写插件的描述信息。

  7. 单击“确定”,创建插件。

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

为API绑定插件

  1. 在左侧的导航栏选择“开发API > API管理”。
  2. 在API列表中,单击要绑定插件的API名称,进入API详情页面。
  3. 在“插件”页签下,单击“绑定插件”。
  4. 在绑定插件弹窗中,选择要绑定插件的“环境”和“插件类型”,然后选中要绑定的插件。
  5. 单击“确定”,完成API与插件的绑定。
分享:

    相关文档

    相关产品