API和SDK的区别

SDK

工程师为辅助开发某类软件的相关文档、范例和工具的集合,使用SDK可以提高开发效率,更简单的接入某个功能。
举例说明:一个产品想实现某个功能,可以找到相关的SDK,工程师直接接入SDK,就不用再重新开发了。

API

前端调用后端数据的一个通道,就是我们俗说的接口,通过这个通道,可以访问到后端的数据,但是又无需调用源代码。
对于api的使用,只要找到需要的API接口,根据接口文档和自己的APP进行对接就可以了。

API文档

API接口一般分为接口描述、接口地址、请求方法、请求参数、相应内容、错误代码、实例几个部分。

  1. 接口描述
    简单描述接口的逻辑和作用
  2. 接口地址
    接口的正式url和接口测试的url,需求方通过调用接口url,获取响应内容
  3. 请求方法
    一般来说,接口最常见的请求方法为GET和POST两种方式,即读接口和写接口。通过这两种方式,实现对数据的增删查改。增删改本质都是写的动作。
  4. 请求参数
    即需要请求的字段名的名称和规则:都是哪些字段,字段的类型是什么,是否必填字段等等
  5. 响应内容
    接口返回的字段名称和规则。
    注意:大部分开发往往不会把所有的字段罗列,只会列出比较重要的字段。当你发现,接口文档中没有你需求的字段,别着急找开发,可以看下实例中,有没有需求的字段。
  6. 错误代码
    对接口的错误用代码进行归类,以便能快速找到错误原因,解决问题。
  7. 实例
    实际调用时的响应的内容。
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值