API接口小知识

之前我们给大家介绍过API是什么，当然我们不需要深入地去了解各个接口的实现原理，毕竟术业有专攻，但是了解什么场景应该使用什么样的接口还是很有必要的，可以方便更好地对外提供数据服务。接下来我们就来简单了解下吧：

什么是接口？

API接口：应用程序接口（API：Application Program Interface），是一组定义、程序及协议的集合，通过 API 接口实现计算机软件之间的相互通信。

电商API接口的类型

1. 根据响应的机制可以分为同步、异步接口：

同步接口：A系统请求B系统接口之后，必须获得B系统接口的响应后才会执行下一步操作。

例如：登录操作的时候调用第三方平台接口（如微信）进行登录，需要跳转到微信进行验证并返回验证结果后，才能登录成功。

异步接口：A系统请求B系统接口之后，不需要等待源系统返回结果就可以进行下一步操作。
例如：在滴滴打车之后，司机点击结束行程后，不需要等待银行付款成功之后再开始下一个订单。因为此时滴滴已经验证过司机、乘客的银行账户或者支付宝账户，确认了双方交易的合法性就可以结束订单。
?

2. 根据接口的触发形式可以分为分发、订阅接口：

分发接口：A系统产生新数据的时候就分发给B系统（也可以是多个）。
例如：电商网站后台的客户管理系统，在产生了一个新的黑名单客户的时候，就会将数据分发到订单、推荐等等各个系统，以便及时拦截这部分客户的订单。

订阅接口：B系统在需要的时候调用A系统的接口进行数据订阅。
例如：用户在股票交易软件中查询银行账户余额的时候才会调用银行的余额查询接口，而股票交易软件自身不存储这个数据。

一般的接口文档由哪些部分组成？

1、接口描述
简单描述接口的逻辑和作用

2、接口调用地址
接口的正式url和接口测试的url，需求方通过调用接口url，获取响应内容

3、请求方法
一般来说，接口最常见的请求方法为GET和POST两种方式，即读接口和写接口。通过这两种方式，实现对数据的增删查改。增删改本质都是写的动作

4、请求参数
即需要请求的字段名的名称和规则

5、响应内容
接口返回的字段名称和规则

6、错误代码
对接口的错误用代码进行归类，以便能快速找到错误原因，解决问题

7、实例
实际调用时的响应的内容