REST API 生命周期管理

步骤一：创建API

步骤二：添加接口

1. 在API列表中单击目标API，在API详情页，添加接口：

   • 如果目标API开启了版本管理，需要先选择版本，后单击添加接口。

     

   • 如果目标API未开启版本管理，单击添加接口。

2. 在创建接口面板中，配置接口相关参数，并单击创建。

   配置项		说明
   接口名称		自定义创建的接口名称，在API下需要全局唯一。
   接口Path		接口的具体路径。
   方法		接口的请求方法。接口的路径+接口的方法，需要在API下全局唯一。
   描述		接口的描述信息。
   API定义信息	请求定义	支持定义Header、Query、Parameter Path参数以及Body参数。 其中Path参数支持在接口Path中三种定义变量的方式： /books/{bookId} /books/[bookId] /books/:bookId 其中，推荐使用{bookId}方式进行定义。 说明 请求定义仅用于生成SDK和文档，不对运行时进行校验。
   	响应定义	定义不同响应码的数据结构。 响应码定义仅用于生成文档，不对运行时进行校验。
   	Mock	Mock配置仅在API发布Mock场景下生效。

步骤一：创建API

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

2. 在左侧导航栏，选择API，并在顶部菜单栏选择地域。

3. 在API管理页面，单击创建API，单击REST API卡片中的导入。

4. 在基于OpenAPI创建文件面板中，配置API相关参数，并单击预检并创建。

   配置项	说明
   API名称	自定义创建的API名称，API名称需要全局唯一。
   上传方式	支持本地文件、OSS文件导入。
   OpenAPI文件	支持选择文件或粘贴文本内容，限制文件大小在30M内。
   版本管理	是否启用API版本管理能力，不同版本的API视为独立的API，它们具有相同的API名称，但API的其他基本信息和接口信息可以不同。访问时需要指定版本标识符。 开启版本管理功能后，需要配置版本号及使用方式。 说明 选择使用方式为Query时，需要配置参数项添加Query。 选择使用方式为Header时，需要配置参数项添加Header。
   版本号	相同API名称下，以版本号进行区分。
   使用方式	支持Path、Query、Header三种方式。 使用Path时，需要完整访问路径为：/API基本路径/版本号/接口路径。 使用Query时，完整访问路径为：/API基本路径/接口路径，请求参数中需要配置参数项添加Query为版本号。 使用Header时，完整访问路径为：/API基本路径/接口路径，请求头中需要配置参数项添加Header为版本号。
   描述	填写API的相关描述。

5. 创建成功后，可在接口列表中查看OpenAPI中定义的接口信息。

步骤二：发布API

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

2. 在发布面板中，配置相关参数，并单击确定。

   配置项	说明
   域名	选择对应的域名进行发布，发布后，支持通过相关域名访问API。 若无域名，可单击创建域名，具体操作，请参见创建域名。
   环境/网关/VPC	将API发布到指定环境。若无发布环境，可单击创建环境，具体操作，请参见环境管理。 重要 若该环境下API已发布，则本次发布将覆盖已发布数据，请谨慎操作。
   使用场景	支持Mock、单服务、按比例（多服务）、按内容（多服务）等场景进行发布。 Mock场景 Mock场景，接口的响应将返回接口定义中的Mock配置，若接口未定义Mock配置，则将无法访问该接口。 发布Mock场景时，要求当前API中至少有一个接口开启了Mock配置，否则将发布失败。 单服务场景 单服务场景，所有流量将转发到某一具体的后端服务。 按比例场景 按比例场景，所有的流量将按比例分发到对应的后端服务中。 说明 要求多个条目的服务权重之和等于100。 按内容场景 按内容场景，所有的流量将按照匹配条件分发到对应的后端服务中，若匹配条件勾选默认，则无其他匹配规则命中时，流量将进入该条目所对应后端服务。 匹配条件支持：等于、前缀是、正则匹配。 参数类型支持：Query、Header。 多个匹配条件之间为“且”运算逻辑。 重要 要求多个条目中，只允许一个条目勾选默认，且其余条目的匹配条件非空。
   后端服务	关联该环境/网关/VPC下的后端服务。若该环境下无后端服务，可单击创建服务创建，具体操作，请参考创建服务。
   发布描述	填写API的发布描述。

步骤三：调试API

1. 在API列表中，单击目标API，进入API详情页，在接口列表中选择需要调试的接口，单击调试接口。

   

2. 在调试接口面板中，配置相关参数进行调试。

   

步骤四：通过域名访问API

1. 在API列表中，选择目标API，单击API详情。

2. 在API详情页中，可查看当前API的发布信息。

   在发布信息中，有两种域名类型：

   • 环境二级域名：系统自动生成，可直接进行访问的公网域名。公网域名仅供API测试使用，直接访问时，每天有100次访问限制。

   • 域名：用户自定义域名，在发布时进行的配置。用户需将该自定义域名CNAME映射到对应的公网二级域名，以实现通过域名对API的访问。通过该方式，将不再受限于公网二级域名100次的访问上限。

   最终对外可访问的路径为：http(s)://{域名}/{BasePath}/接口路径。

步骤五：下线API

1. 在API列表中，选择目标API，进入API详情页，单击API详情页签。

   

2. 在发布信息栏中，单击需要下线的发布记录操作列中的下线。

   

3. 在确认下线弹窗中，单击下线。

   重要

   下线后，无法再通过相关域名访问该API下的所有接口，请谨慎操作。