• 首页 > 
  • CommonRequest 与 SDK 的区别

CommonRequest 与 SDK 的区别

commonRequest 与 SDK 的定义与区别

对比项

CommonRequest

SDK

定义

为开发者封装了签名逻辑,但是所有 API 调用都需要用户自己填写参数,请求方法,请求头等全量信息。

为开发者封装了包括签名逻辑,公有参数,公有请求头等所有通用逻辑,用户不用关注 API 的请求逻辑,只需要关注自身业务参数即可。

签名逻辑

包含,开发者无需关注。

包含,开发者无需关注。

请求方法

需要用户通过文档查询,API 是通过 POST、GET 或其他方法请求后,赋值给 request 对象的对应属性。

开发者无需关注,SDK 中已经生成了相关方法。

公有参数

需要开发者查看文档获取请求 API 对应的产品参数,版本参数,返回体对应格式以及请求的 Action 参数或 API 对应的 URI 参数。

开发者无需关注,SDK 中已经生成了全量公有参数。

业务参数

需要开发者查看文档来查看 API 需要哪些参数,并且需要按照文档指示的格式来序列化参数,序列化开发和调试成本较高。

SDK 中为用户提供了业务参数的结构化 Request 对象,按 Ide 提示即可完成编写,序列化过程由 SDK 完成,保障正确性。

返回结果

直接返回未经处理的字符串,开发者可通过 API 文档查看如何解析结果,并通过文档序列化处理后的返回值组成结构化的对象来使用。

SDK 中为用户做了返回结果的解析,并返回跟文档一致的结构化 Response 对象,按 Ide 提示即可找到自己需要的参数来使用。

产品支持能力

支持所有产品。

部分云产品不提供原版 SDK ,所有云产品提供新版 SDK。

SDK 示例

OpenAPI 开发者门户提供没有原版 SDK 产品的示例。

OpenAPI 开发者门户不仅提供所有新版 SDK 和原版 SDK 示例,还为超过 50 款产品提供了SDK 场景化示例