创建REST API并添加接口

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

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

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

4. 在创建REST API面板中，根据页面提示配置API相关参数。

   配置项	说明
   API名称	自定义创建的API名称。 重要 API名称必须全局唯一。
   API协议	支持HTTP、HTTPS。
   Base Path	API的基本路径，访问具体接口时，完整路径为http(s)://{域名}/{BasePath}/{接口Path}。
   版本管理	是否启用API版本管理能力，不同版本的API视为独立的API，它们具有相同的API名称，但API的其他基本信息和接口信息可以不同。访问时需要指定版本标识符。 开启版本管理功能后，需要配置版本号及使用方式。 说明 选择使用方式为Query时，需要配置参数项添加Query。 选择使用方式为Header时，需要配置参数项添加Header。
   版本号	相同API名称下，以版本号进行区分。
   使用方式	支持Path、Query、Header三种方式。 使用Path时，需要完整访问路径为：/API基本路径/版本号/接口路径。 使用Query时，完整访问路径为：/API基本路径/接口路径，请求参数中需要配置参数项添加Query为版本号。 使用Header时，完整访问路径为：/API基本路径/接口路径，请求头中需要配置参数项添加Header为版本号。
   描述	填写API的相关描述。

添加接口

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

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

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

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

     

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

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

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