概述

1 如何创建API

创建API的方式有三种：通过控制台创建API、通过管控API创建API、通过导入Swagger创建API

• 通过控制台创建API

登录阿里云API网关控制台，左上角选择地域，然后在分组中创建API。具体步骤可参考创建 API

• 使用管控API创建API

可以通过管控API创建API，具体操作可参考CreateApi - 创建 API

• 通过导入Swagger创建API

Swagger是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API。目前有两种方式：

- 通过管控API导入Swagger创建，具体参考ImportSwagger - 通过 Swagger 创建 API；

- 在控制台上进行操作，具体可参考：导入API网关的扩展Swagger定义

2 API网关实例选择及分组

2.1 实例选择

API网关实例指用于接入并处理您的API的一组资源，包含公网IP、内网IP、公网出口、负载均衡，API网关支持共享实例、Serverless 实例和专享实例两种，适用于不同的使用场景：

• 专享实例适用场景：提供高性能和高SLA保证，适合生产环境使用。

• 共享实例适用场景：开发测试、评估和小规模的生产环境使用。

• Serverless实例适用场景：测试及中小规模的生产环境使用。

关于三种实例的具体差异可以参见 实例类型与选择指南。

2.2 分组

API 分组是 API 的管理单元。创建 API 之前，需要先创建分组，分组创建时，系统会为分组分配一个二级域名。该二级域名仅供测试使用，客户端直接调用时会有每天1000次访问限制（海外Region及中国香港限制100次/天）。 建议为分组绑定一个在阿里云系统备案成功的独立域名，进而可以通过域名调用API。

关于分组域名绑定的详细信息可参考使用自定义域名调用API

3 创建API的步骤

3.1 定义请求的基本信息

API基本信息包括API分组、API名称、安全认证方式、API选项和描述。

3.2 定义API请求

定义用户如何请求API，包括请求类型、协议、自定义域名、请求Path、HTTP Method、入参请求模式、和入参定义。

API网关支持的请求协议包括HTTP、HTTPS。

3.3 定义后端服务信息

定义一些参数的前后端映射，即API后端服务的配置，包括后端服务类型、后端服务地址、后端Path、HTTP Method、后端超时时间、参数映射、常量参数、系统参数。用户请求到达API网关后，API网关会根据您的后端配置，映射为对应的后端服务的请求形式，请求后端服务。

API网关支持的后端服务包括HTTP(S)、函数计算、VPC和Mock。

HTTP(S)，通过API网关访问HTTP协议的后端服务

函数计算，函数计算

VPC，使用VPC内资源作为API的后端服务

Mock，Mock

3.4 定义返回结果

录入返回ContentType、返回结果示例、失败返回结果示例、和错误码定义。

4 环境管理

当前每个API分组支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同研发场景下的API 调用需求，如API测试环境，后端服务对应到测试环境资源，从而可以保证在同一套API配置的情况下，供测试人员进行测试使用。

更多详情可参考环境管理