前后端交互---接口详解

一.接口

1.接口的概念

 使用Ajax请求数据时，被请求的URL地址，就叫做数据接口(简称接口)。同时，每个接口必须有请求方式

例如:

2.分析接口的请求过程

①通过get方式请求接口的过程

 

 ②通过post方式请求接口过程

 3.接口测试工具

为了验证接口能否被正常被访问，我们常常需要使用接口测试工具，来对数据接口进行检测。

好处:接口测试工具能让我们在不写任何代码的情况下，对接口进行调用和测试。

 

二.接口文档

1.什么是接口文档

 接口文档，顾名思义就是接口的说明文档，它是我们调用接口的依据。好的接口文档包含了对接口URL，参数以及输出内容的说明，我们参照接口文档就能方便的知道接口的作用，以及接口如何进行调用。

2.接口文档的组成部分 

 接口文档可以包含很多信息，也可以按需进行精简，不过，一个合格的接口文档，应该包含以下6项内容，从而为接口的调用提供依据:

①.接口名称:用来标识各个接口的简单说明，如登录接口，获取图书列表接口等。

②.接口URL:接口的调用地址。

③.调用方式:接口的调用方式，如GET 或 POST。

④.参数格式:接口需要传递的参数，每个参数必须包含参数名称、参数类型、是否必选、参数说明这4项内容。

⑤．响应格式:接口的返回值的详细描述，一般包含数据名称、数据类型、说明3项内容。

⑥.返回示例(可选)︰通过对象的形式，例举服务器返回数据的结构。

例子：