文档

发布API

更新时间:

云原生API网关支持发布API到指定的运行环境。

前提条件

已完成API创建并添加接口。具体操作,请参见创建REST API并添加接口

操作步骤

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,单击API管理,并在顶部菜单栏选择地域。

  3. 在API列表中,单击需要发布的API,进入API详情页面,单击右上角发布API

  4. 在发布面板中,配置相关参数,并单击确定

    配置项

    说明

    域名

    选择对应的域名进行发布,发布后,支持通过相关域名访问API。

    若无域名,可单击创建域名,具体操作,请参见创建域名

    环境/网关/VPC

    将API发布到指定环境。若无发布环境,可单击创建环境,具体操作,请参见环境管理

    重要

    若该环境下API已发布,则本次发布将覆盖已发布数据,请谨慎操作。

    使用场景

    支持Mock单服务按比例按内容按标签等场景进行发布。

    发布Mock场景

    Mock场景,接口的响应将返回接口定义中的Mock配置,若接口未定义Mock配置,则将无法访问该接口。

    发布Mock场景时,要求当前API中至少有一个接口开启了Mock配置,否则将发布失败。

    发布单服务场景

    单服务场景,所有流量将转发到某一具体的后端服务。

    发布按比例场景

    按比例场景,所有的流量将按比例分发到对应的后端服务中。

    说明

    要求多个条目的服务权重之和等于100。

    发布按内容场景

    按内容场景,所有的流量将按照匹配条件分发到对应的后端服务中,若匹配条件勾选默认,则无其他匹配规则命中时,流量将进入该条目所对应后端服务。

    • 匹配条件支持:等于、前缀是、正则匹配。

    • 参数类型支持:Query、Header。

    多个匹配条件之间为“且”运算逻辑。

    重要

    要求多个条目中,只允许一个条目勾选默认,且其余条目的匹配条件非空。

    发布按标签场景

    按标签场景下,所有流量将按比例进入到对应的已有服务的服务版本中。

    说明

    要求多个条目的服务权重之和等于100。

    发布描述

    填写API的发布描述。