API 网关
快速入门
文档版本 01
发布日期 2021-12-08
版权所有 © 华为技术有限公司 2021。 保留一切权利。
非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传 播。
商标声明
和其他华为商标均为华为技术有限公司的商标。
本文档提及的其他所有商标或注册商标，由各自的所有人拥有。
注意
您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或 特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或暗示的声 明或保证。
由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文 档中的所有陈述、信息和建议不构成任何明示或暗示的担保。
目 录
1 概述...1
2 体验 Demo...2
3 开放 API... 5
3.1 开放 API 流程... 5
3.2 创建 API 分组... 6
3.3 绑定域名...7
3.4 创建 API...7
3.5 调试 API... 11
3.6 创建环境（可选）... 12
3.7 发布 API... 13
4 调用 API... 14
4.1 调用 API 流程... 14
4.2 创建应用并获取授权... 15
4.3 为简易认证添加 AppCode... 16
4.4 调用 API... 16
快速入门 目 录
1 概述
API网关（API Gateway）是为您提供高性能、高可用、高安全的API托管服务，帮助 您轻松构建、管理和部署任意规模的API。借助API网关可以简单、快速、低成本、低 风险地实现内部系统集成、业务能力开放。
若您想快速体验开放API和调用API能力，请参考体验Demo，一键式快速完成操作。
若您想快速体验开放API和调用API的操作流程，请参考开放API和调用API。这里以 APP认证类型的简易认证举例，端到端操作快速上手。
快速入门 1 概述
2 体验 Demo
操作场景
此Demo主要用于演示API网关的使用，通过一键式操作，介绍一个具备“HTTP回显”
功能的API的创建、发布以及绑定流控等操作，最终您可以调试或直接调用这个API。
“HTTP回显”API的主要功能为：您通过HTTP GET方式调用API，业务后端将本次调 用的所有请求信息通过response返回给您。
说明
● 您如果需要再次体验Demo，需要先删除Demo第一次创建的API和API分组。
● 第一次体验时会创建一个流控策略，体验后如不需要，可自行删除。
● 本章节介绍共享版体验Demo的操作步骤。专享版体验Demo（香港、乌兰察布二零一、广 州-友好用户环境和国际地区不支持体验Demo）请先在实例的“基本信息”中开启“出口地 址”。
操作步骤
步骤1 登录管理控制台。
步骤2 在管理控制台左上角单击 ，选择区域。
步骤3 单击管理控制台左上角 ，然后单击“API网关 APIG”。
步骤4 单击“体验Demo”，进入“体验Demo”页面。
系统自动完成如下操作：
● 创建分组
● 创建函数
● 创建函数触发器
● 在分组下创建API
● 调试API并发布到RELEASE环境
● 创建流控策略并将API绑定流控策略
快速入门 2 体验 Demo
图2-1 体验 Demo
步骤5 单击“调用API”，进入“调试API”页面。
步骤6 在“查询参数”以及“请求头”处分别添加请求参数与头部消息。
在此Demo中，请求参数与头部消息参数只做演示参考，无实际作用。
● 调试成功时，返回HTTP状态码为“200”和本次调试的请求信息与返回信息。
调试成功后，将回显Demo实际收到的本次请求信息。如下图所示。
● 调试失败时，返回HTTP状态码为4xx或5xx，具体错误信息请参见错误码。
图2-2 调试 API
步骤7 调用API。
1. 在“开放API > API管理”中，单击“HttpEchoDemo”，进入HTTP回显的API详 情页面。
2. 在“总览”页签，在“API URL”所在行，单击 ，复制URL。
快速入门 2 体验 Demo
图2-3 API 详情
3. 在浏览器中粘贴URL，按“Enter”，查看API调用结果。
后端成功返回后，页面显示本次API调用的实际请求信息，即后端Demo服务收到 的API最终信息。
图2-4 调用结果
----结束
快速入门 2 体验 Demo
3 开放 API
3.1 开放 API 流程
作为API提供者开放API，您需要先后完成以下流程：
快速入门 3 开放 API
使用API网关专享版，需要购买专享版实例。API网关共享版不需要购买实例，使 用共享版请参考进入共享版。
2. 创建API分组
API分组相当于API的集合，您在创建API前，需要先创建API分组。
3. 绑定域名
开放API前，您需要为API分组绑定独立域名（即自定义域名），API调用者通过访 问独立域名来调用您开放的API。
4. 创建API
创建API包括定义API前后端的请求路径、参数、请求相关协议等。
5. 调试API
提供调试功能，调试API接口，验证服务是否正常。
6. 创建环境（可选）
API可以同时提供给不同的场景调用，如生产环境（RELEASE）及其他自定义环 境。RELEASE是默认存在的环境，无需创建。
7. 发布API
只有在将API发布到环境后，API才支持被调用。
8. 共享版支持将API上架云市场（可选）
如果您的API希望上架到华为云市场售卖，请参考常见问题：“如何将API上架到 华为云应用市场售卖”。
3.2 创建 API 分组
步骤1 登录API网关控制台。
步骤2 进入共享版或已购买专享版实例。
步骤3 在左侧导航栏选择“开放API > API分组”。
步骤4 单击“创建分组”，配置分组信息。
图3-1 配置分组信息
快速入门 3 开放 API
表3-1 配置分组信息
参数 配置说明
分组名称 填写API分组名称，建议您按照一定的命名规则填写，方 便您快速识别和查找。
描述 对分组的介绍。
步骤5 单击“确定”，创建API分组。系统会同时为其分配一个子域名，您可以用于调试 API。
----结束
3.3 绑定域名
步骤1 在“API分组”页面，单击创建API分组中分组名称，进入分组详情页面。
步骤2 单击“域名管理”页签。
步骤3 单击，填写要绑定的域名。
图3-2 绑定独立域名
说明
填写的独立域名已备案，并且CNAME已解析到分组的子域名上，具体方法请参见增加CNAME 类型记录集。
步骤4 单击“确定”，将独立域名与API分组绑定。
----结束
3.4 创建 API
快速入门 3 开放 API
2. 定义API请求
3. 定义后端服务
4. 定义返回结果
设置基本信息
步骤1 在左侧导航栏选择“开放API > API管理”。
步骤2 单击“新建API”，设置API基本信息。
表3-2 设置基本信息
参数 配置说明
API名称 填写API名称，建议您按照一定的命名规则填写，方便您快速识别 和查找。
所属分组 默认创建API分组中已创建分组。
网关响应 API网关未能成功处理API请求，从而产生的错误响应。
默认的网关响应为“default”。
类型 默认“公开”。
安全认证 选择API认证方式，此处选择“APP认证”。
支持简易认证 简易认证不需要对请求内容签名，API网关也仅校验AppCode，不 校验请求签名，从而实现快速响应。此处开启简易认证。
标签 标签主要用于对API添加分类属性，方便在创建了大量API后，快速 过滤和查找。
快速入门 3 开放 API
参数 配置说明 描述 API的描述。
步骤3 单击“下一步”。
----结束
定义 API 请求
步骤1 在“定义API请求”页面，配置API请求信息。
表3-3 定义 API 请求
参数 配置说明
域名 创建API分组时，系统默认分配的一个子域名。
请求协议 选择API请求协议，此处选择“HTTPS”。
快速入门 3 开放 API
参数 配置说明
支持CORS 为方便起见，此处不开启。
步骤2 单击“下一步”。
----结束
定义后端服务
步骤1 在“定义后端服务”页面，配置后端服务信息。
步骤2 选择后端服务类型，此处选择“HTTP/HTTPS”。
表3-4 HTTP/HTTPS 类型定义后端服务 服务参数 参数说明
协议 选择协议类型，此处选择“HTTP”。
请求方式 接口调用方式，此处选择“POST”。
使用VPC通道 选择“不使用”VPC通道访问后端服务。
后端服务地址 后端服务的地址。
后端请求Path 后端服务的路径。
后端超时 后端服务请求的超时时间。此处默认“5000”ms。
后端认证 后端服务对API调用增加自己的认证。为方便起见，此处不开启。
快速入门 3 开放 API
步骤3 单击“下一步”。
----结束
定义返回结果
步骤1 在“返回结果基础定义”页面，定义返回结果。
表3-5 定义返回结果
信息项 描述
成功响应示例 成功调用API时，返回的响应信息示例。
失败响应示例 调用API失败时，返回的响应信息示例。
步骤2 单击“完成”，完成API的创建。
----结束
3.5 调试 API
步骤1 在“API管理”页面，在已创建API所在行，单击“更多 > 调试”。
步骤2 左侧为API请求参数配置区域，参数说明如表3-6所示。右侧为API发送的请求信息和 API请求调用后的返回结果回显。
表3-6 调试 API
参数 配置说明
协议 仅在API请求的“请求协议”为“HTTP&HTTPS”时，支持修改。
快速入门 3 开放 API
参数 配置说明
请求头 HTTP Headers的参数与参数值。
请求体 仅在API请求的“Method”定义为“PATCH”/“POST”/
“PUT”时，支持修改。
步骤3 单击“发送请求”。
若调用成功时，状态码显示“200”。
----结束
3.6 创建环境（可选）
步骤1 在左侧导航栏选择“开放API > 环境管理”，进入到环境管理信息页面。
步骤2 单击“创建环境”，填写环境信息。
快速入门 3 开放 API
表3-7 环境信息
参数 配置说明
环境名称 填写API环境名称，建议您按照一定的命名规则填写，方便您快速 识别和查找。
描述 环境描述信息。
步骤3 单击“确定”，创建环境。
----结束
3.7 发布 API
步骤1 在左侧导航栏选择“开放API > API管理”，进入到API管理信息页面。
步骤2 在已创建API所在行，单击“发布”。
步骤3 选择API需要发布到的环境。
步骤4 单击“发布”。
----结束
快速入门 3 开放 API
4 调用 API
4.1 调用 API 流程
作为API调用者调用API，您需要完成以下流程：
1. 获取API
从API提供者中获取API和文档信息。
2. 创建应用并获取授权
使用APP认证的API，需要在API网关中创建一个应用，并且绑定API后，才可以使 用APP认证调用API。
3. 为简易认证添加AppCode
快速入门 4 调用 API
使用简易认证，API网关也仅校验AppCode。
4. 调用API
为简单起见，此处使用接口测试工具，通过APP认证方式中的凭证来实现对API的 调用。
4.2 创建应用并获取授权
创建应用
步骤1 在左侧导航栏选择“调用API > 应用管理”，进入到应用管理信息页面。
步骤2 单击“创建应用”，填写应用信息。
表4-1 应用信息
信息项 描述
应用名称 填写应用名称，建议您按照一定的命名规则填写，方便您快速识别 和查找。
描述 对应用的介绍。
步骤3 单击“确定”，创建应用。
步骤4 单击已创建应用名称，进入应用详情页面，查看AppKey和AppSecret。
----结束
绑定 API
步骤1 在绑定的API列表上方，单击“绑定API”。
步骤2 选择开放API中的运行环境、API分组和API，单击“绑定”，完成API绑定策略。
快速入门 4 调用 API
4.3 为简易认证添加 AppCode
步骤1 在应用列表中单击已创建应用名称，进入应用详情。
步骤2 单击“AppCode”页签。
步骤3 单击“添加AppCode”。
步骤4 在弹窗中选择“自动生成”生成方式。
步骤5 单击“确定”。
----结束
4.4 调用 API
使用接口测试工具配置调用信息。
步骤1 获取API请求信息。
为简单起见，此处通过线下传递方式获取API及文档。API调用者可以从中获取API认证 方式，请求方法，请求路径等信息。
步骤2 增加Header参数名称：X-Apig-AppCode，参数值填已生成的AppCode。
步骤3 增加Header参数名称：x-stage，参数值为运行环境。若API发布到RELEASE环境不需 执行此步骤。
步骤4 单击“Send”发送请求。
调用成功后，显示“200 OK”。
----结束
快速入门 4 调用 API
