没有合适的资源?快使用搜索试试~ 我知道了~
首页aws apigateway 文档
aws apigateway 文档
需积分: 50 12 下载量 3 浏览量
更新于2023-03-16
评论
收藏 8.85MB PDF 举报
Amazon API Gateway 是一种完全托管的服务,可以帮助开发者轻松创建、发布、维护、监控和保护任意规模的 API。只需在 AWS 管理控制台中点击几下,您便可以创建可充当应用程序“前门”的 API,从后端服务访问数据、业务逻辑或功能,例如基于 Amazon Elastic Compute Cloud (Amazon EC2) 运行的工作负载、基于 AWS Lambda 运行的代码或任意 Web 应用。Amazon API Gateway 负责管理所有任务,涉及接受和处理成千上万个并发 API 调用,包括流量管理、授权和访问控制、监控以及 API 版本管理。Amazon API Gateway 没有最低费用或启动成本,您只需为收到的 API 调用和传输出去的数据量付费。
资源详情
资源评论
资源推荐
Amazon API Gateway
开发人员指南
Amazon API Gateway 开发人员指南
Amazon API Gateway: 开发人员指南
Copyright © 2017 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner
that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not
owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by
Amazon.
Amazon API Gateway 开发人员指南
Table of Contents
什么是 Amazon API Gateway? ............................................................................................................ 1
连接 AWS 云及其外部的网关 ........................................................................................................ 1
AWS 无服务器基础设施的一部分 ........................................................................................... 2
开发人员体验 ............................................................................................................................. 2
创建和管理 API Gateway API ............................................................................................... 2
调用 API Gateway API ........................................................................................................ 3
API Gateway 的优势 ................................................................................................................... 3
API Gateway 概念 ...................................................................................................................... 3
入门 .................................................................................................................................................. 6
为使用 API Gateway 做好准备 ...................................................................................................... 6
注册 AWS ......................................................................................................................... 6
在您的 AWS 账户中创建 IAM 用户、组或角色 ......................................................................... 7
授予 IAM 用户访问 API Gateway 控制和执行任务的权限 ........................................................... 7
下一步 ............................................................................................................................... 8
构建 API 以便公开 HTTP 终端节点 ................................................................................................ 8
使用示例创建 API ............................................................................................................... 8
逐步构建 API .................................................................................................................... 14
映射请求参数 .................................................................................................................... 23
映射响应负载 .................................................................................................................... 30
构建 API 以公开 Lambda 函数 .................................................................................................... 42
步骤 1:先决条件 .............................................................................................................. 42
步骤 2:创建 API .............................................................................................................. 42
步骤 3:创建资源 .............................................................................................................. 43
步骤 4:创建 Lambda 函数 ................................................................................................ 43
步骤 5:创建并测试 GET 方法 ............................................................................................ 46
步骤 6:创建并测试 POST 方法 .......................................................................................... 46
步骤 7:部署 API .............................................................................................................. 48
步骤 8:测试 API .............................................................................................................. 48
步骤 9:清除 .................................................................................................................... 49
后续步骤 .......................................................................................................................... 49
构建 API 作为 HTTP 或 Lambda 代理 .......................................................................................... 50
创建与测试具有 HTTP 代理集成的 API ................................................................................. 50
通过 代理资源 使用 Lambda 代理集成创建 API ...................................................................... 54
创建 AWS 服务代理 .................................................................................................................. 61
先决条件 .......................................................................................................................... 62
步骤 1:创建资源 .............................................................................................................. 62
步骤 2:创建 GET 方法 ..................................................................................................... 62
步骤 3:创建 AWS 服务代理执行角色 .................................................................................. 63
步骤 4:指定方法设置并测试方法 ........................................................................................ 64
步骤 5:部署 API .............................................................................................................. 65
步骤 6:测试 API .............................................................................................................. 65
步骤 7:清除 .................................................................................................................... 65
创建 API .......................................................................................................................................... 67
创建简单 API ............................................................................................................................ 67
使用 API Gateway 控制台创建 API ...................................................................................... 68
使用适用于 API Gateway 的 AWS SDK 创建 API ................................................................... 68
使用 API Gateway REST API 创建 API ................................................................................ 68
使用 AWS CLI 命令创建 API .............................................................................................. 73
通过导入 Swagger 定义来创建 API ...................................................................................... 75
设置方法和集成 ......................................................................................................................... 76
设置方法和集成之前 .......................................................................................................... 76
设置集成请求 .................................................................................................................... 76
设置方法请求 .................................................................................................................... 78
设置方法与集成之间的数据映射 ........................................................................................... 79
iii
Amazon API Gateway 开发人员指南
处理在 API Gateway 中的 Lambda 错误 ............................................................................... 81
启用二进制负载支持 .......................................................................................................... 85
为方法配置模拟集成 ......................................................................................................... 101
设置代理集成 .................................................................................................................. 104
设置方法和集成之后 ......................................................................................................... 111
为请求和响应负载创建模型和映射模板 ........................................................................................ 111
模型 .............................................................................................................................. 112
映射模板 ........................................................................................................................ 115
模型和映射模板的任务 ...................................................................................................... 117
创建模型 ........................................................................................................................ 117
查看模型列表 .................................................................................................................. 118
删除模型 ........................................................................................................................ 118
照片示例 ........................................................................................................................ 118
新闻文章示例 .................................................................................................................. 121
销售发票示例 .................................................................................................................. 125
员工记录示例 .................................................................................................................. 129
请求和响应数据映射 ................................................................................................................. 133
将方法请求数据映射至集成请求参数 ................................................................................... 134
将集成响应数据映射到方法响应标头 ................................................................................... 135
在方法和集成之间映射请求和响应负载 ................................................................................ 136
集成传递行为 .................................................................................................................. 136
映射方法请求数据以自定义网关响应 ................................................................................... 137
映射模板内置函数和变量 ........................................................................................................... 142
访问 $context 变量 .......................................................................................................... 142
访问 $input 变量 ............................................................................................................. 144
访问 $stageVariables 变量 ................................................................................................ 147
访问 $util 变量 ................................................................................................................ 147
为 API 启用基本请求验证 .......................................................................................................... 148
API Gateway 中的基本请求验证概览 .................................................................................. 148
在 API Gateway 中设置基本请求验证 ................................................................................. 149
在 API Gateway 中测试基本请求验证 ................................................................................. 153
启用基本请求验证的示例 API 的 Swagger 定义 .................................................................... 156
记录 API ................................................................................................................................ 159
API 文档在 API Gateway 中的表示形式 .............................................................................. 159
使用 API Gateway 控制台记录 API ................................................................................... 167
使用 API Gateway REST API 记录 API ............................................................................. 175
发布 API 文档 ................................................................................................................. 190
导入 API 文档 ................................................................................................................. 194
控制对 API 文档的访问权限 .............................................................................................. 197
导入 API ................................................................................................................................ 197
使用导入 API 创建新 API .................................................................................................. 197
使用导入 API 更新现有 API ............................................................................................... 198
Swagger basePath .......................................................................................................... 199
导入过程中出现错误 ......................................................................................................... 200
导入过程中出现警告 ......................................................................................................... 200
控制访问 ................................................................................................................................ 200
使用 IAM 许可 ................................................................................................................ 201
为资源启用 CORS ........................................................................................................... 213
使用自定义授权方 ............................................................................................................ 216
使用 Amazon Cognito 用户池 ............................................................................................ 227
使用客户端 SSL 证书 ....................................................................................................... 231
受支持的 HTTP 和 HTTP 代理集成证书颁发机构 .................................................................. 234
使用 API Gateway 使用计划 ............................................................................................. 254
维护 API ................................................................................................................................ 265
查看 API 列表 ................................................................................................................. 265
删除 API ........................................................................................................................ 265
删除资源 ........................................................................................................................ 266
iv
Amazon API Gateway 开发人员指南
查看方法列表 .................................................................................................................. 266
删除方法 ........................................................................................................................ 266
部署 API ........................................................................................................................................ 268
从控制台部署 API .................................................................................................................... 268
将 API 部署到阶段 ........................................................................................................... 269
更新部署的阶段配置 ......................................................................................................... 269
为部署设置阶段变量 ......................................................................................................... 269
将阶段与不同的部署相关联 ................................................................................................ 269
管理阶段 ................................................................................................................................ 270
将现有部署与新阶段进行关联 ............................................................................................. 270
更新阶段设置 .................................................................................................................. 270
删除阶段 ........................................................................................................................ 272
优化 API 性能 ......................................................................................................................... 272
限制 API 请求 ................................................................................................................. 273
启用 API 缓存 ................................................................................................................. 274
设置阶段变量 .......................................................................................................................... 278
使用案例 ........................................................................................................................ 279
示例 .............................................................................................................................. 279
设置阶段变量 .................................................................................................................. 279
使用阶段变量 .................................................................................................................. 281
阶段变量引用 .................................................................................................................. 286
导出 API ................................................................................................................................ 288
请求导出 API .................................................................................................................. 288
下载 JSON 格式的 API Swagger 定义 ................................................................................ 288
下载 YAML 格式的 API Swagger 定义 ................................................................................ 288
借助 Postman 扩展下载 JSON 格式的 API Swagger 定义 ...................................................... 289
借助 API Gateway 集成下载 YAML 格式的 API Swagger 定义 ................................................ 289
使用 API Gateway 控制台导出 API .................................................................................... 289
生成 API 的软件开发工具包 ...................................................................................................... 289
使用 API Gateway 控制台为 API 生成软件开发工具包 ........................................................... 290
简单计算器 Lambda 函数 .................................................................................................. 291
API Gateway 中的简单结算器 API ...................................................................................... 293
简单计算器 API Swagger 定义 .......................................................................................... 298
设置自定义域名 ....................................................................................................................... 303
在 AWS Certificate Manager 中准备好证书 .......................................................................... 304
为 API Gateway API 设置自定义域名 ................................................................................. 306
在 CloudTrail 中记录自定义域名的创建操作 ......................................................................... 309
配置其中自定义域名作为主机名的 API 的基本路径映射 .......................................................... 310
轮换 ACM 中导入的证书 ................................................................................................... 310
调用具有自定义域名的 API ................................................................................................ 311
将您的 API 作为 SaaS 进行销售 ................................................................................................ 312
初始化 AWS Marketplace 与 API Gateway 的集成 ................................................................ 312
处理使用计划的客户订阅 ................................................................................................... 313
调用 API ........................................................................................................................................ 316
在 API Gateway 控制台中获取 API 的调用 URL ........................................................................... 317
使用控制台测试方法 ................................................................................................................. 317
先决条件 ........................................................................................................................ 317
使用 API Gateway 控制台测试方法 .................................................................................... 317
使用 Postman 调用 API ............................................................................................................ 318
使用 API Gateway 生成的 Java 软件开发工具包 ........................................................................... 318
使用由 API Gateway 生成的 Android 软件开发工具包 .................................................................... 321
使用 API Gateway 生成的 JavaScript 软件开发工具包 ................................................................... 323
在 Objective-C 或 Swift 中使用由 API Gateway 生成的 iOS SDK ..................................................... 325
使用生成的 iOS 软件开发工具包 (Objective-C) 来调用 API ..................................................... 325
使用生成的 iOS 软件开发工具包 (Swift) 来调用 API .............................................................. 329
使用 CloudWatch 跟踪 API 调用 ................................................................................................ 333
使用 CloudTrail 记录 API 管理调用 .................................................................................... 334
v
剩余447页未读,继续阅读
fengwuhenQ
- 粉丝: 4
- 资源: 13
上传资源 快速赚钱
- 我的内容管理 收起
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
会员权益专享
最新资源
- 2023年中国辣条食品行业创新及消费需求洞察报告.pptx
- 2023年半导体行业20强品牌.pptx
- 2023年全球电力行业评论.pptx
- 2023年全球网络安全现状-劳动力资源和网络运营的全球发展新态势.pptx
- 毕业设计-基于单片机的液体密度检测系统设计.doc
- 家用清扫机器人设计.doc
- 基于VB+数据库SQL的教师信息管理系统设计与实现 计算机专业设计范文模板参考资料.pdf
- 官塘驿林场林防火(资源监管)“空天地人”四位一体监测系统方案.doc
- 基于专利语义表征的技术预见方法及其应用.docx
- 浅谈电子商务的现状及发展趋势学习总结.doc
- 基于单片机的智能仓库温湿度控制系统 (2).pdf
- 基于SSM框架知识产权管理系统 (2).pdf
- 9年终工作总结新年计划PPT模板.pptx
- Hytera海能达CH04L01 说明书.pdf
- 数据中心运维操作标准及流程.pdf
- 报告模板 -成本分析与报告培训之三.pptx
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0