阿里云API网关服务.docx

阿里云API网关服务 API 网关用法手册〔开放API〕.7. 用法手册〔开放API〕 供应APIAPI网关〔API Gateway〕，供应高性能、高可用的API托管效劳，关心您对外开放您部署在ECS、容器效劳等阿里云产品上的应用，为您供应完好的API发布、管理、维护生命周期管理。您只需简洁操作，即可快速、低本钱、低风险的开放数据或效劳。在API网关您可以：管理您的API 您可以对API的整个生命周期进展管理，包括API的创立、测试、发布、下线、版本切换等操作。便捷转换数据 支持自定义映射规章，您可以配置映射将调用恳求转换成后端需要的格式。预设恳求校验 您可以预先设置参数类型、参数值〔范围、枚举、正那么、Json Schema〕校验，由网关关心您过滤掉非法恳求，削减您的后端对非法恳求的处理本钱。敏捷掌握流量 您可以对API、用户、应用设置按分钟、小时、天的调用量掌握。您还可以设置特例用户或者应用，对某个用户或应用单独配置流量掌握。轻松平安防护支持Appkey认证，HMAC〔SHA-1,SHA-256〕算法签名。支持SSL/TSL加密，并借助阿里云盾防病毒、防攻击。全面监控与报警 为您供应可视化API实时监控，包括：调用量、调用方式、响应时间、错误率，并支持历史状况查询，以便统筹分析。您还可以配置预警方式〔短信、Email〕,订阅预警信息，以便实时把握API运行状况。降低开放本钱 为您自动生成API文档和SDK〔效劳端、挪动端〕，降低API开放本钱。 创立API创立API是定义API恳求的过程。您需要在创立中定义API的恳求调用格式、定义网关抛向后端效劳的恳求格式、定义返回结果格式、定义参数校验规章等等。定义恳求的根本信息API根本信息包括API分组、API名称、描绘、API类型。 1.2. 3.1. 2.3.1. 2.3. 4. 5.API创立时需要选择分组。分组是API的管理单元，创立API之前您需要先创立分组。〔API分组的具体说明见下文的分组及域名〕分组携带Region属性且每个分组有不同的域名，同一个分组下的API的Region和域名都是一样的。分组一旦选定不行更改。API名称应为该分组下唯一，一旦选定不行更改。API类型分为公开和私有两种。在公测阶段，两种类型无实际差异。定义恳求的后端效劳信息API后端效劳信息包括后端效劳类型、后端效劳地址和后端超时时间。后端效劳类型。目前仅支持HTTP，其他类型如Sigma、Mock后续会陆续支撑。后端效劳地址。是指API网关调用底层效劳时的完好地址，包含域名/IP+Path。可以包含动态参数，比方动态参数为username，写作[username]，这些动态参数只能从调用者传入的Path中猎取，所以您需要在下一步配置Path时选择性的做映射，并且定义最终Path时不要遗漏这些动态参数。后端效劳地址中不能包含Query参数。后端超时时间。指API恳求到达网关后，由网关去调API后端效劳的响应时间，由网关恳求后端开头到网关收到后端返回结果的时间。该值不能超过30秒。定义API恳求格式API恳求格式定义包括协议及方法定义、Path的定义、入参定义、系统参数定义、参数映射、参数校验定义。协议及方法定义。API调用支持HTTP/HTTPS协议。Method方法可选择PUT、GET、POST、DELETE、HEAD、MULITIPART。Path定义。这个Path是指效劳对外开放后，调用者调用API网关时的途径，可以与后端效劳地址中的Path不同，网关会保存对应关系完成寻址。假如您输入的后端效劳地址中存在动态参数，这些动态参数需要通过Path猎取，您可以在定义Path的时候进展参数映射，留意最终的Path地址不要遗漏这些动态参数。只要保证该Path中的动态参数与后端效劳地址中的动态参数相对应即可，其他局部可以与后端效劳地址中的Path不同。入参定义。您在这局部定义用户调用API时需要传入的参数，分别对恳求的Header、Query和Body进展入参定义。您需要定义用户恳求传入的参数名称，参数类型如String、Number、Boolean、Json等。选择参数是否必填，并给出示例值、默认值及描绘。Body参数可以选择透传。参数校验定义。在定义入参时，您还可以点击更多来为该参数设置校验，如枚举值、String的长度校验、Number的最大最小值校验等等。网关会预先对非法恳求进展拦截，减轻您后端效劳的负担。参数映射。假如您想要用户输入的参数名称与您后端实际的参数名称不符，或者您后端实际参数名称不便利挺直暴露给用户，那么您只需要在定义参数时选择需要参数映射，既可以为每个参数配置起