目标:服务器相关的基本概念;客户端和服务器的通信过程;Ajax应用场景;Jquery中Ajax函数请求数据;接口和接口文档的概念;
1. 客户端与服务器
刷微博
浏览新闻
在线听音乐
在线看电影
etc…
上网的本质目的
:通过互联网的形式来获取和消费资源
1.2 服务器
上网过程中,负责存放和对外提供资源
的电脑,叫做服务器
1.3 客户端
上网过程中,负责获取和消费资源
的电脑,叫做客户端
2. URL地址
2.1 URL地址的概念
URL(全称是UniformResourceLocator)中文叫统一资源定位符
,用于标识互联网上每个资源的唯一存放位置。浏览器只有通过URL地址,才能正确定位资源的存放位置,从而成功访问到对应的资源。
常见的URL举例:
http://www.baidu.com
http://www.taobao.com
http://www.cnblogs.com/liulongbinblogs/p/11649393.html
2.2 URL地址的组成部分
URL地址一般由三部组成:
① 客户端与服务器之间的通信协议
② 存有该资源的服务器名称
③ 资源在服务器上具体的存放位置
3. 客户端与服务器的通信过程
3.1 图解客户端与服务器的通信过程
3.2 基于浏览器的开发者工具分析通信过程
4. 服务器对外提供了哪些资源
4.1 例举网页中常见的资源
4.2 数据也是资源
网页中的数据,也是服务器对外提供的一种资源
。例如股票数据、各行业排行榜等。
4.3 数据是网页的灵魂
4.4 网页中如何请求数据
如果要在网页中请求服务器上的数据资源,则需要用到 XMLHttpRequest 对
象。
XMLHttpRequest
(简称 xhr)是浏览器提供的 js 成员,通过它,可以请求服务器上的数据资源。
最简单的用法 var xhrObj = new XMLHttpRequest()
4.5 资源的请求方式
客户端请求服务器时,请求的方式
有很多种,最常见的两种请求方式分别为 get
和 post
请求。
-
get 请求通常用于
获取服务端资源(
向服务器要资源)例如:根据 URL 地址,从服务器获取 HTML 文件、css 文件、js文件、图片文件、数据资源等
-
post 请求通常用
于向服务器提交数据
(往服务器发送资源)例如:登录时向服务器提交的登录信息、注册时向服务器提交的注册信息、添加用户时向服务器提交的用户信息等各种
数据提交操作
5. 了解Ajax
5.1 什么是Ajax
-
Ajax 的全称是
Asynchronous Javascript And XML
(异步 JavaScript 和 XML)。 -
通俗的理解:在网页中利用
XMLHttpRequest
对象和服务器进行数据交互的方式,就是Ajax。
5.2 为什么要学Ajax
之前所学的技术,只能把网页做的更美观漂亮,或添加一些动画效果,但是,Ajax
能让我们轻松实现网页与服务器之间
的数据交互
。
5.3 Ajax的典型应用场景
用户名检测:注册用户时,通过 ajax 的形式,动态检测用户名是否被占用
5.3 Ajax的典型应用场景
搜索提示:当输入搜索关键字时,通过 ajax 的形式,动态加载搜索提示列表
数据分页显示:当点击页码值的时候,通过 ajax 的形式,根据页码值动态刷新表格的数据
数据的增删改查:数据的添加、删除、修改、查询操作,都需要通过 ajax 的形式,来实现数据的交互
6. jQuery中的Ajax
6.1 了解jQuery中的Ajax
浏览器中提供的 XMLHttpReques
t 用法比较复杂,所以 jQuery 对 XMLHttpRequest 进行了封装,提供了一系列 Ajax 相关的函数,极大地降低了 Ajax 的使用难度
。
jQuery 中发起 Ajax 请求最常用的三个方法如下:
$.get()
$.post()
$.ajax()
6.2 $.get()
函数的语法
- jQuery 中 $.get() 函数的功能单一,专门用来发起 get 请求,从而将服务器上的资源请求到客户端来进行使用。 $.get()
函数的语法如下:
$.get(url, [data], [callback])
其中,三个参数各自代表的含义如下:
6.2 $.get()发起不带参数
的请求
使用 $.get() 函数发起不带参数的请求时,直接提供请求的 URL 地址
和请求成功之后的回调函数
即可,示例代码如下:
$.get('http://www.liulongbin.top:3006/api/getbooks', function(res) {
console.log(res) // 这里的 res 是服务器返回的数据
})
$.get()
发起带参数的
请求
$.get('http://www.liulongbin.top:3006/api/getbooks', { id: 1 }, function(res) {
console.log(res)
})
6.3 $.post()函数的语法
Query 中 $.post() 函数的功能单一,专门用来发起 post 请求,从而向服务器提交数据。
$.post() 函数的语法如下:
$.post(url, [data], [callback])
其中,三个参数各自代表的含义如下:
6.3 $.post()向服务器提交数据
$.post(
'http://www.liulongbin.top:3006/api/addbook', // 请求的URL地址
{ bookname: '水浒传', author: '施耐庵', publisher: '上海图书出版社' }, // 提交的数据
function(res) { // 回调函数
console.log(res)
}
)
6.4 $.ajax()函数的语法
相比于 $.get() 和 $.post() 函数,jQuery 中提供的 $.ajax() 函数,是一个功能比较综合的函数,它允许我们对 Ajax 请求进行更详细的配置。
$.ajax() 函数的基本语法如下:
$.ajax({
type: '', // 请求的方式,例如 GET 或 POST
url: '', // 请求的 URL 地址
data: { },// 这次请求要携带的数据
success: function(res) { } // 请求成功之后的回调函数
})
使用$.ajax()发起GET请求
使用 $.ajax() 发起 GET 请求时,只需要将 type 属性
的值设置为 'GET'
即可
$.ajax({
type: 'GET', // 请求的方式
url: 'http://www.liulongbin.top:3006/api/getbooks', // 请求的 URL 地址
data: { id: 1 },// 这次请求要携带的数据
success: function(res) { // 请求成功之后的回调函数
console.log(res)
}
})
**使用$.ajax()发起POST请求
**
$.ajax({
type: 'POST', // 请求的方式
url: 'http://www.liulongbin.top:3006/api/addbook', // 请求的 URL 地址
data: { // 要提交给服务器的数据
bookname: '水浒传',
author: '施耐庵',
publisher: '上海图书出版社'
},
success: function(res) { // 请求成功之后的回调函数
console.log(res)
}
})
7.接口
7.1 接口的概念
使用 Ajax 请求数据时,被请求的 URL 地址
,就叫做数据接口
(简称接口)。同时,每个接口必须有请求方式
。
例如:
http://www.liulongbin.top:3006/api/getbooks 获取图书列表的接口(GET请求)
http://www.liulongbin.top:3006/api/addbook 添加图书的接口(POST请求)
7.2 分析接口的请求过程
- 通过GET方式请求接口的过程
- 通过POST方式请求接口的过程
7.3 接口测试工具
- 什么是接口测试工具
为了验证接口能否被正常被访问,我们常常需要使用接口测试工具,来对数据接口进行检测。
好处
:接口测试工具能让我们在不写任何代码
的情况下,对接口进行调用
和测试
。
访问 PostMan 的官方下载网址https://www.getpostman.com/downloads/
,下载所需的安装程序后,直接安装即可。 - 了解PostMan界面的组成部分
7.4 使用PostMan测试GET接口
7.5 使用PostMan测试POST接口
7.6 接口文档
1. 什么是接口文档
接口文档,顾名思义就是接口的说明文档,它是我们调用接口
的依据。好的接口文档包含了对接口URL,参数
以及输出内容
的说明,我们参照接口文档就能方便的知道接口的作用,以及接口如何进行调用。
2. 接口文档的组成部分
接口文档可以包含很多信息,也可以按需进行精简,不过,一个合格的接口文档,应该包含以下6项内容,从而为接口的调用提供依据:
-
接口名称
:用来标识各个接口的简单说明,如登录接口,获取图书列表接口等。 -
接口URL
:接口的调用地址。 -
调用方式
:接口的调用方式,如 GET 或 POST。 -
参数格式
:接口需要传递的参数,每个参数必须包含参数名称、参数类型、是否必选、参数说明这4项内容。 -
响应格式
:接口的返回值的详细描述,一般包含数据名称、数据类型、说明3项内容。 -
返回示例(可选):通过对象的形式,例举服务器返回数据的结构。
3. 接口文档示例
请求的根路径
http://www.liulongbin.top:3006
请求的根路径
http://www.liulongbin.top:3006
图书列表
- 接口URL: /api/getbooks
- 调用方式: GET
- 参数格式:
参数名称 | 参数类型 | 是否必选 | 参数说明 |
---|---|---|---|
id | Number | 否 | 图书Id |
bookname | String | 否 | 图书名称 |
author | String | 否 | 作者 |
publisher | String | 否 | 出版社 |
- 响应格式:
数据名称 | 数据类型 | 说明 |
---|---|---|
status | Number | 200 成功;500 失败; |
msg | String | 对 status 字段的详细说明 |
data | Array | 图书列表 |
+id | Number | 图书Id |
+bookname | String | 图书名称 |
+author | String | 作者 |
+publisher | String | 出版社 |
- 返回示例:
{
"status": 200,
"msg": "获取图书列表成功",
"data": [
{ "id": 1, "bookname": "西游记", "author": "吴承恩", "publisher": "北京图书出版社" },
{ "id": 2, "bookname": "红楼梦", "author": "曹雪芹", "publisher": "上海图书出版社" },
{ "id": 3, "bookname": "三国演义", "author": "罗贯中", "publisher": "北京图书出版社" }
]
}
添加图书
- 接口URL: /api/addbook
- 调用方式: POST
- 参数格式:
参数名称 | 参数类型 | 是否必选 | 参数说明 |
---|---|---|---|
bookname | String | 是 | 图书名称 |
author | String | 是 | 作者 |
publisher | String | 是 | 出版社 |
- 响应格式:
数据名称 | 数据类型 | 说明 |
---|---|---|
status | Number | 201 添加成功;500 添加失败; |
msg | String | 对 status 字段的详细说明 |
- 返回示例:
{
"status": 201,
"msg": "添加图书成功"
}
删除图书
- 接口URL: /api/delbook
- 调用方式: GET
- 参数格式:
参数名称 | 参数类型 | 是否必选 | 参数说明 |
---|---|---|---|
id | Number | 是 | 图书Id |
- 响应格式:
数据名称 | 数据类型 | 说明 |
---|---|---|
status | Number | 200 删除成功;500 未指定要删除的图书Id;501 执行Sql报错;502 要删除的图书不存在; |
msg | String | 对 status 字段的详细说明 |
- 返回示例:
{
"status": 200,
"msg": "删除图书成功!"
}