创建REST API并添加接口

实例外API

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

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

3. 单击创建API。

4. 单击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。

1. 单击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

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

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

3. 在实例页面，单击目标实例ID进入概览页面。然后单击左侧导航栏API，并单击创建API。

4. 单击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下的后端服务。若该网关下无后端服务，可单击创建服务创建。 重要 在新建服务时，服务端口信息可能不会立即显示。您需要展开服务名称的下拉列表并单击刷新。由于端口信息同步是异步进行的，可能需要稍等片刻才能加载并显示完整的服务端口信息。

实例外API

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

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

3. 单击创建API。

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

   配置项	说明
   API名称	自定义创建的API名称，API名称必须全局唯一。
   上传方式	支持本地文件、OSS文件导入和自定义URL。 说明 本地文件、OSS文件导入和自定义URL中的文件均符合OpenAPI规范。
   OpenAPI文件	在选择本地文件时配置，支持选择文件或粘贴文本内容，限制文件大小在30M内。
   Region选择	在选择OSS文件导入时配置，选择地域，以便选择其OSS资源。
   OSS Bucket	在选择OSS文件导入时配置，选择OSS Bucket，暂不支持无地域属性的Bucket。
   URL	自定义URL地址，用于上传基于OpenAPI创建的文件。
   版本管理	是否启用API版本管理能力，不同版本的API视为独立的API，它们具有相同的API名称，但API的其他基本信息和接口信息可以不同。访问时需要指定版本标识符。 开启版本管理功能后，需要配置使用方式。 说明 选择使用方式为Query时，需要配置参数项添加Query。 选择使用方式为Header时，需要配置参数项添加Header。
   使用方式	支持Path、Query、Header三种方式。 使用Path时，需要完整访问路径为：/API基本路径/版本号/接口路径。 使用Query时，完整访问路径为：/API基本路径/接口路径，请求参数中需要配置参数项添加Query为版本号。 使用Header时，完整访问路径为：/API基本路径/接口路径，请求头中需要配置参数项添加Header为版本号。
   描述	填写API的相关描述。
   资源组	选择目标资源组。您可单击右侧的创建资源组。

实例内API

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

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

3. 在实例页面，单击目标实例ID进入概览页面。然后单击左侧导航栏API，并单击创建API。

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

   配置项	说明
   API名称	自定义创建的API名称，API名称必须全局唯一。
   域名	选择API需要匹配的域名，支持选择多个域名。 如果您需要创建新的域名，可以直接单击添加域名，在面板中进行创建。
   上传方式	支持本地文件、OSS文件导入和自定义URL。 说明 本地文件、OSS文件导入和自定义URL中的文件均符合OpenAPI规范。
   OpenAPI文件	在选择本地文件时配置，支持选择文件或粘贴文本内容，限制文件大小在30M内。
   Region选择	在选择OSS文件导入时配置，选择地域，以便选择其OSS资源。
   OSS Bucket	在选择OSS文件导入时配置，选择OSS Bucket，暂不支持无地域属性的Bucket。
   URL	自定义URL地址，用于上传基于OpenAPI创建的文件。 自定义URL地址，用于上传基于OpenAPI创建的文件。
   版本管理	是否启用API版本管理能力，不同版本的API视为独立的API，它们具有相同的API名称，但API的其他基本信息和接口信息可以不同。访问时需要指定版本标识符。 开启版本管理功能后，需要配置使用方式。 说明 选择使用方式为Query时，需要配置参数项添加Query。 选择使用方式为Header时，需要配置参数项添加Header。
   使用方式	支持Path、Query、Header三种方式。 使用Path时，需要完整访问路径为：/API基本路径/版本号/接口路径。 使用Query时，完整访问路径为：/API基本路径/接口路径，请求参数中需要配置参数项添加Query为版本号。 使用Header时，完整访问路径为：/API基本路径/接口路径，请求头中需要配置参数项添加Header为版本号。
   描述	填写API的相关描述。
   资源组	选择目标资源组。您可单击右侧的创建资源组。
   使用场景	选择当前接口的使用场景。 基础场景：单服务。 灰度场景：按比例（多服务）、按内容（多服务）、标签路由（按比例）。 说明 涉及权重的目标服务流量比例总和要求为100%。
   后端服务	关联该网关/VPC下的后端服务。若该网关下无后端服务，可单击创建服务创建。 重要 在新建服务时，服务端口信息可能不会立即显示。您需要展开服务名称的下拉列表并单击刷新。由于端口信息同步是异步进行的，可能需要稍等片刻才能加载并显示完整的服务端口信息。