AJAX——什么是接口，使用什么工具节省时间

Try Tomato

已于 2022-03-15 11:23:18 修改

阅读量1.1k

点赞数 1

分类专栏： + Ajax 文章标签： ajax 前端服务器 javascript 数据仓库

于 2022-03-15 11:08:56 首次发布

本文链接：https://blog.csdn.net/weixin_63836026/article/details/123496963

版权

+ Ajax 专栏收录该内容

11 篇文章 1 订阅

订阅专栏

我们使用AJAX请求数据时，被请求的URL地址，就叫做数据接口（接口），而每一个接口，都必须有请求方式（GET/POST）

就比如我们在上节博客中讲到的图书添加和获取，我们仔细观察不难看出，获取图书列表的接口（GET请求）和添加图书的接口（POST请求）是不一样的

http://www.liulongbin.top:3006/api/getbooks这是获取图书的接口

http://www.liulongbin.top:3006/api/addbook这是添加图书的接口

一.接口文档

二.接口测试工具（postman）

我们理解了什么是接口，接下来我们再来了解一下接口文档：

一.接口文档

接口文档就是接口的说明文档，它是我们调用接口的依据，好的接口文档包含了URL，参数，输出内容的说明，使我们查阅接口文档就知道接口的作用以及接口如何进行调用

接口文档可以包含很多的信息，也可以精炼一点，但是一个合格的接口文档，应该有以下6种，为接口的调用提供依据

接口文档的组成部分：

1.接口名称：用来标识各个接口的简单说明

2.接口URL：接口的调用地址

3.调用方式：GET/POST等

4.参数格式：接口需要传递的参数，每个参数必须包含参数名称，参数类型以及参数说明，是否必选

5.响应格式：接口返回值的详细描述，一般包含数据名称，数据类型，参数说明

6.【返回示例】：通过对象的形式，举例服务器返回数据的结构

//返回示例
{
    status: 200, 
    msg: "获取图书列表成功", 
    data: [
        {id: 1, bookname: "西游记", author: "吴承恩", publisher: "北京图书出版社"},

        {id: 2, bookname: "红楼梦", author: "曹雪芹", publisher: "上海图书出版社"},

        {id: 3, bookname: "三国演义", author: "罗贯中", publisher: "北京图书出版社"}
    ]
}