阿里云冷门 API/SDK 对接心得

以『媒体转码服务』为例

这里提到的冷门指的是网上缺少讨论,出现问题难以搜索到解决方案,难以获得讨论的SDK,如何依靠有限的经验解决当前问题。

首先要树立一个信心:

  • 阿里爸爸的产品这么香,肯定不是某个不负责任的小编用两张网图编出来了个api接口。

  • 就算是产品再不人性化,也是经过了严格的评定和测试流程才挂到阿里云产品ㅤ骗钱ㅤ 造福大众的的。

  • 获取制作这个产品的时候阿里云投入的产品力量不足,或许开发者由于某些思维惯性,没有在文档中写入一些细节,或者我们的知识、经验积累还不够,没办法第一时间理解某些参数的含义。

  • 但是只要挖掘到阿里云在编写文档时的盲点,理解了调用方式,最终总能完成对接,给自己的技能库添砖加瓦。

与官方文档的第一步交锋

  • 当我们尝试从官方途径寻找文档的时候,第一步总是能找到阿里云的『帮助文档』,对于很多热门产品,尤其是如OSS般的当红炸子鸡,赚钱小能手,这类产品的帮助文档已经被打磨的足够完善。

  • 可惜今天的例子『媒体转码服务』可能还不在此列。当你点击入我提供的链接时,聪明的你可能很快就会发现一个问题:接口地址是什么?

  • 当然我们不能冤枉阿里云帮助文档,他们在媒体服务中还是提供了接口地址的,接口地址位于 >媒体处理 >API参考 >调用方式 >请求结构 >服务地域。如果要我们每个人都像这样去寻找每一个信息,那就要求我们每个人都要把整篇文档大致读一遍。这样就增加了很多的学习成本。

  • 回到『媒体转码服务』的帮助文档继续往下读,你会发现接口还需要我们提供一个管道ID模板ID。读到这里我们已经意识到了问题的严重性:不要逃课了,先把整篇文档通读一遍吧,求求你了。

  • 很抗拒,通读太累了。那就挑一些关键的信息看一看。比如API概述调用方式之类的。这时候我们再顺手翻一翻控制台,能得到阿里云提供的一个固定的管道ID,使用控制台手动转码,能从他们的调用方式里获得公共的默认的模板ID。有点儿像是玩解密RPG?

  • OK,信息够了,但也没完全够,这些接口还要验签。看到验签我终于坚持不下去了,继续逃课,选择使用他们封装好的SDK做开发。

SDK:逃课好帮手

  • 文档中的SDK 参考要我们看『安装』,安装文档给了我们一个github 仓库,和一行require_once代码。

  • 感谢composer为我们养成了懒惰的引用习惯,看到require_once我不自觉要寻找composer版本的引用。但网上查到的都是抱怨阿里云自己没做composer,和个人自己做的composer版本。

  • 这还是在2021年4月18日的搜索结果,在4天后的22号,情况已经不同了。

  • 跳过自己改composer的步骤,后来我在查询资料的时候发现阿里云悄悄推出了新的SDK平台『阿里云OpenApi』。这两天好像正在排查旧SDK的引用,准备全面引入新的平台上。

  • 但是不要高兴的太早,等真正细读下来才发现这个平台对我们的冷门SDK还是没有足够的支持。只告诉你要用哪个方法调用这一步,参数要怎么填,是什么格式,什么含义,依旧一头雾水。

SDK不完善,只能靠API文档来补课。

  • 某些SDK的相关示例中,有标识为社区提供,但明显不是社区写的输入参数示意,提到了参数格式,参数含义,参数详情。当我们点击『参数详情』时,API 文档:没想到吧,我又回来啦!

  • SDK 初始化中要填写一个参数 $config->endpoint。一开始我在这里填了ossendpointSDK直接报错404,内容大概是it is not a map,翻阅多层源代码才知道,这个endpoint就是接口调用地址,也就是之前我们在API文档中找到的服务地域

  • 我充分利用以上多方面数据来源,终于将SDK跑了起来。这一步常常会遇到数据格式不正确的报错。这时候要结合文档,示例,将参数传递方式在以下多种格式中选择合适的格式使用。


[

    // 数组

    "input" => [

        'Bucket'    => config('aliyun.oss.bucket'),

        'Location'    => config('aliyun.mts.location'),

        'Object'    => urlencode($url),

    ],

    // json 对象

    "input" => json_encode([

        'Bucket'    => config('aliyun.oss.bucket'),

        'Location'    => config('aliyun.mts.location'),

        'Object'    => urlencode($url),

    ]),

    // json 数组

    "input" => json_encode([

        [

            'Bucket'    => config('aliyun.oss.bucket'),

            'Location'    => config('aliyun.mts.location'),

            'Object'    => urlencode($url),

        ],

        [

            'Bucket'    => config('aliyun.oss.bucket'),

            'Location'    => config('aliyun.mts.location'),

            'Object'    => urlencode($url),

        ],

    ]),

]
本作品采用《CC 协议》,转载必须注明作者和本文链接
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!