API网关具备自动生成多语言SDK的能力

本文涉及的产品
云原生 API 网关,700元额度,多规格可选
简介: 首先,API网关按照使用用户的不同分别给API提供者(Provider)和API使用者(Consumer)提供了不同的SDK生成入口。对于Provider而言,他们可以在API网关自动生成他们拥有的Group下的所有线上API的调用SDK。

API网关为了实现客户端和服务器端之间的安全通讯,设计了全套的签名策略,只有携带通过复杂的签名算法的签名请求头的请求才会被API网关转发给后端服务器,否则请求会被API网关拒绝。这个连接是API签名算法的具体说明:https://help.aliyun.com/document_detail/29475.html,相信大家看到签名算法的介绍,会发现该签名算法有一定的复杂度,实现起来需要花费不少的时间,还需要和网关联调,有一定的工作量。

作为API网关的用户,要想正确得使用API网关的各项能力,就需要自己在客户端实现API网关定义签名算法。还有一个选项就是,使用API网关官方提供的SDK。本文不是给大家介绍签名算法的,而是给大家介绍API网关的SDK生成能力。

首先,API网关按照使用用户的不同分别给API提供者(Provider)和API使用者(Consumer)提供了不同的SDK生成入口。对于Provider而言,他们可以在API网关自动生成他们拥有的Group下的所有线上API的调用SDK。Consumer则可以在API网关下载基于应用(App)维度的SDK,比如consumer的一个应用(App)购买了并被授权拥有A,B,C三个API,那么consumer可以在API网关一键生成A,B,C三个API的调用SDK,不管这三个接口是否属于同一个API供应商,都能在一个SDK包能下载下来。

下面是API网关为API提供者(Provider)提供的SDK生成页面,左边API网关->开放API->SDK/文档自动生成是页面的入口。我们可以看到,Provider可以选择Region和Group来生成指定语言的SDK。

SDK自动生成

下面是API网关为API使用者(Consumer)提供的SDK生成页面,左边API网关->调用API->已授权API的SDK 是页面的入口。我们可以看到,Consumer可以选择指定应用(App)来生成指定语言的SDK。

SDK自动生成

API网关目前提供iOS,Android两种移动客户端的SDK的自动生成功能,基本覆盖了绝大部分移动客户端。API网关还提供大众语言Java的SDK的自动生成功能。后继,我们还会陆续推出PHP,Python,.NET,Node.js等主流语言的SDK的自动生成能力。

下面我们介绍下API网关自动生成的SDK压缩包内的文件结构,以Android为例,其他语言的都比较类似:

  • SDK文件夹

    • sdk

      • Demo_{{groupName}}.java Api调用示例
      • SyncApiClient_{{groupName}}.java 对应Group的所有API同步接口实现,直接调用本类实现Api调用
      • AsyncApiClient_{{groupName}}.java 对应Group的所有API接口异步实现,直接调用本类实现Api调用
      • AppConfigurationInitializer.java APP秘钥配置类,使用API调用之后需要先配置本类
    • lib

      • alibaba-cloudapi-sdk-core-1.0.1.jar sdk的core包,实现底层通信
    • src sdk文件夹中使用的alibaba-cloudapi-sdk-core-1.0.1.jar的源码

      • CloudApiSdk.java SDK处理HTTP请求的类
      • AppConfiguration.java SDK配置类
      • SignUtil.java 签名的实现类
      • HttpConstant.java SDK用到的Http常量
      • SDKConstant.java SDK内部用到的常量
      • CallMethod.java 同步、异步枚举
    • doc

      • ApiDocument_{{groupName}}.md 对应Group的API接口文档
    • Readme.md SDK使用指南
    • LICENSE 版权许可说明

本SDK非常容易使用,完全按照Readme配置后以后,就可以像SDK的Demo那样调用API接口了,下面是一个非常简单的调用示例:

public static void testPathSyncTest(){
        SyncApiClient_GroupName.testPath("test" , "test" , "test" , new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                String result = e.getMessage();
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                String result= getResultString(response);
            }
        });
    }

SDK压缩包中有所有涉及的API的MD格式的相关文档,包括API描述信息,参数信息,请求信息及应答、错误码等所有信息,下面是一个截图:

SDK自动生成的文档

如果在使用中遇到棘手的问题,请加入我们官方旺旺群来找我们,群号:1640106170

目录
相关文章
|
2月前
|
API 开发工具 图形学
PicoVR Unity SDK⭐️五、常用API接口函数一览
PicoVR Unity SDK⭐️五、常用API接口函数一览
|
2月前
|
JSON Java API
【Azure API 管理】通过Java APIM SDK创建一个新的API,如何为Reqeust的Representation设置一个内容示例(Sample)?
【Azure API 管理】通过Java APIM SDK创建一个新的API,如何为Reqeust的Representation设置一个内容示例(Sample)?
|
3月前
|
存储 并行计算 开发工具
SLS Prometheus存储问题之相比客户端SDK聚合写入,SLS网关侧聚合写入有什么优势
SLS Prometheus存储问题之相比客户端SDK聚合写入,SLS网关侧聚合写入有什么优势
|
2月前
|
缓存 JavaScript 前端开发
微信 JS-SDK Demo “分享信息设置” API 及数字签名生成方法(NodeJS版本)
微信 JS-SDK Demo “分享信息设置” API 及数字签名生成方法(NodeJS版本)更新时间(2020-10-29)
|
3月前
|
分布式计算 大数据 Go
MaxCompute操作报错合集之使用go sdk调用GetTunnelEndpoint出现报错:InvalidAction.NotFoundSpecified api is not found,该如何解决
MaxCompute是阿里云提供的大规模离线数据处理服务,用于大数据分析、挖掘和报表生成等场景。在使用MaxCompute进行数据处理时,可能会遇到各种操作报错。以下是一些常见的MaxCompute操作报错及其可能的原因与解决措施的合集。
|
4月前
|
安全 API 开发工具
全面对比API和SDK
全面对比API和SDK
183 0
|
4月前
|
API 开发工具
企业微信SDK接口API调用-触发推送企业微信微信好友
企业微信SDK接口API调用-触发推送企业微信微信好友
|
4月前
|
Java API 开发工具
企业微信api,企业微信sdk接口java调用源码
企业微信api,企业微信sdk接口java调用源码
|
4月前
|
API 开发工具
抖音sdk,抖音开发api接口
抖音sdk,抖音开发api接口
|
4月前
|
API 开发工具
企业微信api接口,企业微信sdk
企业微信api接口,企业微信sdk
下一篇
无影云桌面