[JavaScript知识库]Ajax(一)

Ajax

Ajax 的全称是 Asynchronous Javascript And XML（异步 JavaScript 和 XML）。

通俗的理解：在网页中利用 XMLHttpRequest 对象和服务器进行数据交互的方式，就是Ajax。

简单理解:Ajax能让我们轻松实现网页与服务器之间的数据交互。

浏览器中提供的 XMLHttpRequest 用法比较复杂，所以 jQuery 对 XMLHttpRequest 进行了封装，提供了一系列 Ajax 相关的函数，极大地降低了 Ajax 的使用难度。

jQuery 中发起 Ajax 请求最常用的三个方法如下：

• $.get()
• $.post()
• $.ajax()

get方法

jQuery 中 $.get() 函数的功能单一，专门用来发起 get 请求，从而将服务器上的资源请求到客户端来进行使用。

$.get() 函数的语法如下：

$.get(url,[data],[callback])

其中，三个参数各自代表的含义如下：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-MtvOrxEG-1662879772361)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220911082524352.png)]

使用 $.get() 函数发起不带参数的请求时，直接提供请求的 URL 地址和请求成功之后的回调函数即可，示例代码如下：

$(function () {
      $('#btnGET').on('click', function () {
        $.get('http://www.liulongbin.top:3006/api/getbooks', function (res) {
          console.log(res)
        })
      })

POST方法

$.post()函数的语法如下:

$.post(url,[data],[callback])

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-9MkXil0B-1662879772363)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220911083821946.png)]

**$.ajax()**函数的语法

相比于 $.get() 和 $.post() 函数，jQuery 中提供的 $.ajax() 函数，是一个功能比较综合的函数，它允许我们对 Ajax 请求进行更详细的配置。

$.ajax() 函数的基本语法如下：

$.ajax({
	type:'',//请求方法 GET或POST
	url:'',  //请求的URL地址
	data:{ },//这次请求要携带的数据
	success:function(res){} //请求成功之后的回调函数
})

POST调用如下:

$.ajax({
   type: 'POST', // 请求的方式
   url: 'http://www.liulongbin.top:3006/api/addbook',  // 请求的 URL 地址
   data: { // 要提交给服务器的数据
      bookname:?'水浒传',
      author:?'施耐庵',
      publisher:?'上海图书出版社'
    },
   success: function(res) { // 请求成功之后的回调函数
       console.log(res)
   }
})

接口

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

例如：

http://www.liulongbin.top:3006/api/getbooks 获取图书列表的接口(GET请求)

http://www.liulongbin.top:3006/api/addbook 添加图书的接口（POST请求）

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-JhXK2Mu8-1662879772363)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220911091134543.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-jV1iqBHR-1662879772364)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20220911091145833.png)]

接口测试工具

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

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

接口文档

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

接口文档的组成部分

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

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

接口URL ：接口的调用地址。

调用方式：接口的调用方式，如 GET 或 POST。

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

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

返回示例（可选）：通过对象的形式，例举服务器返回数据的结构。