云原生API网关提供的REST API支持API设计、开发、测试、发布、下线的全生命周期管理，通过标准的HTTP方法对资源进行操作，适用于API First、API精细化管控等场景，本文帮助您快速体验相关功能。
通过控制台创建REST API
云原生API网关提供了实例内和实例外两种创建API的方式：
实例外API
登录云原生API网关控制台。
单击左侧导航栏API，并在顶部菜单栏选择地域。
单击创建API。
单击REST API卡片中的创建，在创建REST API面板中配置相关参数，单击确定。
配置项
说明
API名称
自定义创建的API名称，API名称必须全局唯一。
Base Path
API的基本路径，访问具体接口时，完整路径为
http(s)://{域名}/{BasePath}/{接口Path}。版本管理
是否启用API版本管理能力，不同版本的API视为独立的API，它们具有相同的API名称，但API的其他基本信息和接口信息可以不同。访问时需要指定版本标识符。
开启版本管理功能后，需要配置使用方式。
说明选择使用方式为Query时，需要配置参数项添加Query。
选择使用方式为Header时，需要配置参数项添加Header。
使用方式
支持Path、Query、Header三种方式。
使用Path时，需要完整访问路径为：/API基本路径/版本号/接口路径。
使用Query时，完整访问路径为：/API基本路径/接口路径，请求参数中需要配置参数项添加Query为版本号。
使用Header时，完整访问路径为：/API基本路径/接口路径，请求头中需要配置参数项添加Header为版本号。
描述
填写API的相关描述。
资源组
选择目标资源组。您可单击右侧的创建资源组。
单击创建API。
单击REST API卡片中的创建，在创建REST API面板中配置相关参数，单击确定。
配置项
说明
API名称
自定义创建的API名称，API名称必须全局唯一。
Base Path
API的基本路径，访问具体接口时，完整路径为
http(s)://{域名}/{BasePath}/{接口Path}。版本管理
是否启用API版本管理能力，不同版本的API视为独立的API，它们具有相同的API名称，但API的其他基本信息和接口信息可以不同。访问时需要指定版本标识符。
开启版本管理功能后，需要配置使用方式。
说明选择使用方式为Query时，需要配置参数项添加Query。
选择使用方式为Header时，需要配置参数项添加Header。
使用方式
支持Path、Query、Header三种方式。
使用Path时，需要完整访问路径为：/API基本路径/版本号/接口路径。
使用Query时，完整访问路径为：/API基本路径/接口路径，请求参数中需要配置参数项添加Query为版本号。
使用Header时，完整访问路径为：/API基本路径/接口路径，请求头中需要配置参数项添加Header为版本号。
描述
填写API的相关描述。
资源组
选择目标资源组。您可单击右侧的创建资源组。
实例内API
登录云原生API网关控制台。
单击左侧导航栏实例，并在顶部菜单栏选择地域。
在实例页面，单击目标实例ID进入概览页面。然后单击左侧导航栏API，并单击创建API。
单击REST API卡片中的创建，在创建REST API面板中配置相关参数，单击确定。
配置项
说明
API名称
自定义创建的API名称，API名称必须全局唯一。
域名
选择API需要匹配的域名，支持选择多个域名。
如果您需要创建新的域名，可以直接单击添加域名，在面板中进行创建。
Base Path
API的基本路径，访问具体接口时，完整路径为
http(s)://{域名}/{BasePath}/{接口Path}。版本管理
是否启用API版本管理能力，不同版本的API视为独立的API，它们具有相同的API名称，但API的其他基本信息和接口信息可以不同。访问时需要指定版本标识符。
开启版本管理功能后，需要配置使用方式。
说明选择使用方式为Query时，需要配置参数项添加Query。
选择使用方式为Header时，需要配置参数项添加Header。
使用方式
支持Path、Query、Header三种方式。
使用Path时，需要完整访问路径为：/API基本路径/版本号/接口路径。
使用Query时，完整访问路径为：/API基本路径/接口路径，请求参数中需要配置参数项添加Query为版本号。
使用Header时，完整访问路径为：/API基本路径/接口路径，请求头中需要配置参数项添加Header为版本号。
描述
填写API的相关描述。
资源组
选择目标资源组。您可单击右侧的创建资源组。
使用场景
选择当前接口的使用场景。
基础场景：单服务。
灰度场景：按比例（多服务）、按内容（多服务）、标签路由（按比例）。
说明涉及权重的目标服务流量比例总和要求为100%。
后端服务
关联该网关/VPC下的后端服务。若该网关下无后端服务，可单击创建服务创建。
重要在新建服务时，服务端口信息可能不会立即显示。您需要展开服务名称的下拉列表并单击刷新。由于端口信息同步是异步进行的，可能需要稍等片刻才能加载并显示完整的服务端口信息。
添加接口
在REST API中，单击添加接口。
在创建接口面板中配置相关参数，单击添加。
配置项
说明
接口名称
自定义创建的接口名称，在API下需要全局唯一。
接口Path
接口的具体路径。
方法
接口的请求方法。接口的路径+接口的方法，需要在API下全局唯一。
描述
接口的描述信息。
请求定义
支持定义Header、Query、Parameter Path参数以及Body参数。
其中Path参数支持在接口Path中三种定义变量的方式：
/books/{bookId}
/books/[bookId]
/books/:bookId
其中，推荐使用{bookId}方式进行定义。
说明请求定义仅用于生成SDK和文档，不对运行时进行校验。
响应定义
定义不同响应码的数据结构。
响应码定义仅用于生成文档，不对运行时进行校验。
Mock
Mock配置仅在API发布Mock场景下生效。
说明实例外支持REST API的Mock配置功能，实例内暂不支持Mock配置。
消费者认证
开启或关闭消费者认证，默认关闭。开启消费者认证后，需为当前接口绑定消费者授权关系，否则无法访问。
发布API
云原生API网关提供了实例内和实例外两种发布API的方式：
实例外API
登录云原生API网关控制台。左侧导航栏选择API，并在顶部菜单栏选择地域。
单击目标API。单击右上方的发布。
在发布API面板中配置相关参数，然后单击发布。
配置项
说明
域名
选择对应的域名进行发布，发布后，支持通过相关域名访问API。
若无域名，可单击添加域名，具体操作，请参见创建域名。
所属实例
选择所创建的云原生API网关实例。不同的业务环境可用不同的实例区分，实现API在多环境上的发布。
使用场景
使用场景包括基础场景和灰度场景两类。关于目标服务不同类型说明，请参见路由。
基础场景
Mock：接口的响应将返回接口定义中的Mock配置，若接口未定义Mock配置，则将无法访问该接口。
说明发布Mock场景时，要求当前API中至少有一个接口开启了Mock配置，否则将发布失败。
单服务：所有流量请求将转发到某一具体的后端服务（最常使用的场景）。
灰度场景
按比例（多服务）：所有的流量将按比例分发到对应的后端服务中，常用于切流及灰度发布场景。
说明要求多个条目的服务权重之和等于100。
按内容（多服务）：所有的流量将按照匹配条件分发到对应的后端服务中，若匹配条件勾选默认，则无其他匹配规则命中时，流量将进入该条目所对应后端服务。
匹配条件支持：等于、前缀是、正则匹配。
参数类型支持：Query、Header。
多个匹配条件之间为“且”运算逻辑。
重要要求多个条目中，只允许一个条目勾选默认，且其余条目的匹配条件非空。
标签路由（按比例）：标签路由场景，所有流量将按比例分发到多个后端服务的多个版本。全链路灰度场景下推荐优先使用单服务路由，以获得更好的性能与体验。
后端服务
关联该网关/VPC下的后端服务。若该网关下无后端服务，可单击创建服务创建，具体操作，请参考创建服务。
发布描述
填写API的发布描述。
实例内API
登录云原生API网关控制台。左侧导航栏选择实例，并在顶部菜单栏选择地域。
在实例页面，单击目标网关实例ID。左侧导航栏选择API，单击目标API。
单击右上方的发布，在发布API面板中配置相关参数，然后单击发布。
配置项
说明
实例
所创建的云原生API网关实例。不同的业务环境可用不同的实例区分，实现API在多环境上的发布。
所属VPC
实例接口所属VPC。
发布范围
API级接口发布范围，可以选择接口名称查看受影响接口详情。
发布描述
填写API的发布描述。
调试接口
在API列表中，单击目标API。
在接口列表页签，选择需要调试的接口，单击调试。
在调试接口面板中，配置相关参数，然后单击发送请求进行调试。
通过域名访问API
在API列表中，选择目标API，单击API详情。
在API详情页中，可查看当前API的发布信息。
在发布信息中，有两种域名类型：
环境二级域名：系统自动生成，可直接进行访问的公网域名。公网域名仅供API测试使用，直接访问时，每天有100次访问限制。
域名：用户自定义域名，在发布时进行的配置。用户需将该自定义域名CNAME映射到对应的公网二级域名，以实现通过域名对API的访问。通过该方式，将不再受限于公网二级域名100次的访问上限。
最终对外可访问的路径为：http(s)://{域名}/{BasePath}/接口路径。
下线API
下线后，所有相关域名将无法访问该API下的接口。虽然API实例将停止处理请求，但其配置和历史记录仍会保留在系统中，请谨慎执行此操作。
云原生API网关提供了实例内和实例外两种下线API的方式：
实例外API
登录云原生API网关控制台。左侧导航栏选择API，并在顶部菜单栏选择地域。
单击目标API。单击右上角的。
实例内API
登录云原生API网关控制台。左侧导航栏选择实例，并在顶部菜单栏选择地域。
在实例页面，单击目标网关实例ID。左侧导航栏选择API，单击目标API。
单击右上角的。
在确认下线对话框中，单击下线。