API接口文档

什么是API接口？

API事实上是在内部预先定义了函数，能够使开发人员无须明白API内部实现的机制，就能够实现某一个功能

比如说你要实现一个手机注册的功能，那么相应地后台工程师就需要提供一个手机注册的接口，前端开发人员在调用接口实现功能的时候，只需按照既定的规则进行请求即可，不需要去理解该功能的实现逻辑。有了这么一个机制，就使得开发人员间的协作变得非常简洁、高效。

电商平台的前台和后台之间接口调用：

在查询界面，前端需要将搜索框中输入的参数传输到后端去查询结果，后端如何处理业务获取数据，这些方法形成一个接口，就是内部接口

比如在医院，内科检查时，医生不能很清楚了解你的具体情况，这个时候需要借助第三方工具———内科仪器，仪器检查后的数据通过电脑输出给医生。在这个事件中，仪器电脑是外部接口

例如：

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

① 同步接口是实时交互的

② 同步接口有时间限制，超过有限时间，就会报错 timeout

① 异步接口交互不是实时的

②异步接口你需要自己去查询，通过调用另一个接口查看结果，或者你给他们一个回调的地址，他做完之后通过这个地址返回信息给你

做一个打车的APP：

现需要在页面上展现地图的功能，对公司而言，新做地图功能未免成本过高，那我们可以在高德开放平台或者百度地图的开放平台，找到地图API，这样的话我们只需要购买高德的服务，部署调用高德地图API，这样就可以快速在我们页面上线地图功能了。

通过API，即使不知道对方系统内部如何操作，也能实现自己的系统与对方系统的交互

Application（应用程序） ：API 是应用程序的一部分，它允许其他程序与它进行交互。
Protocol （协议）：规定两个端之间的传输应该遵从什么规则， 常见的协议有 HTTP、HTTPS 等。就像我们说话需要遵循语法和词汇，API 通信也需要遵守这些协议。
Interface（接口）：可以类比为银行中的窗口，不同接口对应不同的服务窗口。
Format（格式）：两个端之间传输的介质，比如JSON/XML

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

接口描述：简单描述接口的逻辑和作用。
接口地址：接口地址向开发者说明在何处使用接口服务
接口的正式 url 和接口测试的 url，需求方通过调用接口 url，获取响应内容。
请求方法：一般来说，接口最常见的请求方法为 GET 和 POST 两种方式，即读接口和写接口。通过这两种方式，实现对数据的增删查改。增删改本质都是写的动作。
新增 (POST)、修改 (PUT)、删除 (DELETE) 和获取 (GET)
请求参数：即需要请求的字段名的名称和规则：每个参数的类型、默认值和限制条件等
了解接口大致的功能与使用方法后，现在需要请求方按照特定的格式填写请求内容。API 接口的本质是预先定义好的函数逻辑

例如，某项接口主要提供计算功能，此时需求方希望得到输入 1+1 后的计算结果，其中 1+1 就是请求参数

注意：

大部分开发往往不会把所有的字段罗列，只会列出比较重要的字段。当你发现，接口文档中没有你需求的字段，别着急找开发，可以看下实例中，有没有需求的字段。