欢迎来到天天文库
浏览记录
ID:36204941
大小:136.11 KB
页数:4页
时间:2019-05-07
《阿里云API网关服务-快速入门-D》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库。
1、API网关快速入门(开放API)API网关/快速入门(开放API)快速入门(开放API)概述本文将快速引导您创建并开放API。您需要依次完成以下步骤才能成功开放API服务:创建API分组API分组是API的管理单元,先创建API分组,然后在分组下创建API。分组有Region属性,API选定分组就选定了Region,不可更改。分组创建时,会绑定一个唯一的二级域名,您可以访问该二级域名调用该分组下测试中的API。若要开放API服务,您需要为分组绑定独立域名,独立域名需要在阿里云系统备案并且CNAM
2、E到该分组的二级域名上,用户访问独立域名调用该分组下线上的API。如果您的API支持HTTPS协议,您还需要为该独立域名上传SSL证书。绑定域名和证书域名是绑定在API分组上面的,API网关通过域名来定位到一个唯一的API分组,再通过Path+HTTPMethod确定唯一的API。如果您需要开放API则需要为分组绑定独立域名。独立域名需要满足以下几点:1.独立域名在阿里云系统备案成功,请求才能到达您的后端服务。2.若域名是在其他系统备案,则需要接入阿里云备案系统才能使用。备案和接入流程。3API
3、网关/快速入门(开放API)1.独立域名要CNAME解析到该分组的二级域名上,后操作绑定。先解析,后绑定,否则绑定操作会报错。2.域名验证需要在一天内完成,一天之内未完成的绑定请求会被系统自动回收。3.若您需要将其他分组的独立域名变更到当前分组,需要先变更解析,才能成功绑定。完成备案和CNAME解析就完成了域名绑定,若备案接入过程有疑问可以查看--备案和接入流程。若该分组下的API支持HTTPS协议,您还需要为该独立域名上次SSL证书。不支持文件上传,需要填写证书名称、内容和私钥。创建APIAP
4、I分组创建完成您就可以创建API了,创建API是定义API请求的过程。您需要在创建中依次定义以下内容:1.API的基本信息:分组、名称、类型、描述。分组一旦选定,Region就选定了,不可更改。2.API的后端服务信息:后端服务类型、服务地址、服务超时时间。服务地址中可以包含动态参数,这些动态参数会被带到Path的设置中,服务地址中的参数只能从Path中接受。3.API请求格式:协议、方法、Path、参数(包括Headers、Query、Body、常量参数和系统参数)、参数映射、参数校验。注意所
5、有的参数名称彼此不能重复,所有的后端参数名称彼此不能重复。4.API返回结果:返回类型及示例,目前网关对于返回结果不做处理。至此完成API的创建,并且具备开放的条件。更多详细的说明请看使用手册(开放API)。发布API您完成API创建后,可以将API发布到测试,您可以创建自己的APP,然后通过访问二级域名调用测试中的API。调用API的方法,请您查看使用手册(调用API)。如果您成功绑定了独立域名,那么可以将API发布到线上,您给客户的APP授权后,您的客户可以通过访问独立域名调用您线上的API
6、。API网关支持您对测试/线上的API做版本管理,您可以发布API、下线API还可以切换版本,切换版本是实时生效。授权给应用应用(APP)代表请求者的身份。每个应用匹配AppKey和AppSecret用于计算加密签名,网关会完成请求者身份验证。当您的客户或者您自己测试调用API时,都需要创建APP作为请求者的身份。然后由您该APP授权。授权操作需要以下几个步骤:3API网关/快速入门(开放API)1.获知待授权的APP的AppID或者APP所有者的阿里云邮箱账号。2.在授权操作页面,选择一个或者
7、多个准备开放调用权限的API,选定测试/线上。3.选定API后,用AppID或者阿里云邮箱账号搜索到APP。4.确认授权。至此,您已经完成API的创建与开放,客户可以调用您的API了。请求到达网关时,网关会完成对APP的身份验证和权限验证。您还可以为您的API设置安全防护,如设置流量控制策略限定访问流量。网关还支持后端服务加签,您可以设定签名密钥,当网关向您的后端抛请求时做身份验证。安全与管理接下来您可以配置安全防护。目前API网关为您提供后端签名和流量控制策略两种安全措施。签名密钥服务用于您后
8、端做身份验证。您为API绑定了签名密钥之后,由网关抛向您后端的请求将携带签名信息,您可以在后端通过对称加密对请求进行签名验证。具体HTTP加签说明请查看文档--后端HTTP服务签名流量控制策略服务用于管制您API服务的流量。您为API绑定了流量控制策略之后,网关将协助您对API、用户、应用设置按分钟、小时、天的调用量控制。您还可以在控制台进行更多API生命周期的管理操作,如API下线、API版本切换、API调用情况监控和预警等。更多详情请您查看使用手册(开放API)。3
此文档下载收益归作者所有