接口管理

本文旨在介绍如何通过控制台管理接口的关键步骤,包括为接口指定后端服务、添加策略、配置消费者认证等操作。

为接口指定后端服务

重要
  • 在实例外创建的API中,添加的接口默认继承其关联后端服务的配置,但不支持对后端服务进行编辑。

  • 在实例内创建的API中,添加的接口默认继承其关联后端服务的配置,同时也可以为该接口单独设置配置。

  1. 登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。

  2. 实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API。

  3. 在目标接口的接口详情页签,单击后端服务右侧的编辑

  4. 后端服务区域配置相关参数,单击确认

    配置项

    描述

    配置方式

    配置方式默认为继承自API

    • 单独为接口配置:接口单独关联后端服务,优先于API级。

    • 继承自API:继承自API所关联的后端服务。

    使用场景

    选择当前接口的使用场景。

    • 基础场景:单服务Mock

    • 灰度场景:按比例(多服务)按内容(多服务)标签路由(按比例)

    说明

    涉及权重的目标服务流量比例总和要求为100%。

    后端服务

    关联该网关/VPC下的后端服务。若该网关下无后端服务,可单击创建服务创建。

    重要

    在新建服务时,服务端口信息可能不会立即显示。您需要展开服务名称的下拉列表并单击刷新。由于端口信息同步是异步进行的,可能需要稍等片刻才能加载并显示完整的服务端口信息。

调试接口

前提条件

发布API

操作步骤

  1. 云原生API网关提供了实例内和实例外两种调试接口的方式:

    实例外API

    1. 登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。

    2. 单击目标API。

    实例内API

    1. 登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。

    2. 实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API。

  2. 接口列表页签,选择需要调试的接口,单击调试

  3. 调试接口面板中,配置相关参数,然后单击发送请求进行调试。

编辑接口

云原生API网关提供了实例内和实例外两种编辑接口的方式:

实例外API

  1. 登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。

  2. 单击目标API。在接口列表页签,选择需要编辑的接口,单击编辑

  3. 编辑接口面板中,可修改接口基本信息请求定义响应定义Mock消费者认证

实例内API

  1. 登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。

  2. 实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API。

  3. 接口列表页签,选择需要编辑的接口,单击编辑

  4. 编辑接口面板中,可修改接口基本信息请求定义响应定义消费者认证

压测

前提条件

发布API

操作步骤

  1. 云原生API网关提供了实例内和实例外两种压测的方式:

    实例外API

    1. 登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。

    2. 单击目标API。

    实例内API

    1. 登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。

    2. 实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API。

  2. 接口列表页签,选择需要压测的接口,单击更多操作 > 压测。详细操作,请参见PTS压测快速入门

删除接口

重要

删除接口操作不可逆,请谨慎执行此操作。

  1. 云原生API网关提供了实例内和实例外两种删除接口的方式:

    实例外API

    1. 登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。

    2. 单击目标API。

    实例内API

    1. 登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。

    2. 实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API。

  2. 接口列表页签,选择需要删除的接口,单击更多操作 > 删除,然后在删除对话框单击确定