ajax2

目录

接口

1.接口的概念

2.分析接口的请求过程

3.接口测试工具

1.什么是接口测试工具

2. 下载并安装PostMan

3. 了解PostMan界面的组成部分

4. 使用PostMan测试GET接口

5 .使用PostMan测试POST接口

6. 接口文档

案例 - 图书管理 

1.渲染UI结构

2.案例用到的库和插件 

3.渲染图书列表（核心代码） 

4.删除图书（核心代码）

5.添加图书（核心代码）

6.添加图书的Panel面板

7.图书的表格

---

接口

1.接口的概念

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

例如：

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

2.分析接口的请求过程

 

3.接口测试工具

1.什么是接口测试工具

为了验证接口能否被正常被访问，我们常常需要使用接口测试工具，来对数据接口进行检测。 好处：接口测试工具能让我们在不写任何代码的情况下，对接口进行调用和测试。

2. 下载并安装PostMan

访问 PostMan 的官方下载网址 https://www.getpostman.com/downloads/，下载所需的安装程序后，直接安装即可。

3. 了解PostMan界面的组成部分

 4. 使用PostMan测试GET接口

 5 .使用PostMan测试POST接口

 

6. 接口文档

1. 什么是接口文档

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

2. 接口文档的组成部分

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

1. 接口名称：用来标识各个接口的简单说明，如登录接口，获取图书列表接口等。  
2. 接口URL：接口的调用地址。  
3. 调用方式：接口的调用方式，如 GET 或 POST。  
4. 参数格式：接口需要传递的参数，每个参数必须包含参数名称、参数类型、是否必选、参数说明这4项内容。  
5. 响应格式：接口的返回值的详细描述，一般包含数据名称、数据类型、说明3项内容。  
6. 返回示例（可选）：通过对象的形式，例举服务器返回数据的结构。

3. 接口文档示例 

 

案例 - 图书管理 

1.渲染UI结构

2.案例用到的库和插件 

• 用到的 css 库 bootstrap.css
• 用到的 javascript 库 jquery.js
• 用到的 vs code 插件 Bootstrap 3 Snippets

3.渲染图书列表（核心代码） 

function getBookList() {
    // 1. 发起 ajax 请求获取图书列表数据
    $.get('http://www.liulongbin.top:3006/api/getbooks', function(res) {
        // 2. 获取列表数据是否成功
        if (res.status !== 200) return alert('获取图书列表失败！')
        // 3. 渲染页面结构
        var rows = []
        $.each(res.data, function(i, item) { // 4. 循环拼接字符串
            rows.push('<tr><td>' + item.id + '</td><td>' + item.bookname + '</td><td>' + item.author + '</td><td>' + item.publisher + '</td><td><a href="javascript:;">删除</a></td></tr>')
        })
        $('#bookBody').empty().append(rows.join('')) // 5. 渲染表格结构
    })
}

4.删除图书（核心代码）

// 1. 为按钮绑定点击事件处理函数
$('tbody').on('click', '.del', function() {
    // 2. 获取要删除的图书的 Id
    var id = $(this).attr('data-id')
    $.ajax({ // 3. 发起 ajax 请求，根据 id 删除对应的图书
        type: 'GET',
        url: 'http://www.liulongbin.top:3006/api/delbook',
        data: { id: id },
        success: function(res) {
            if (res.status !== 200) return alert('删除图书失败！') 
            getBookList() // 4. 删除成功后，重新加载图书列表
        }
    })
})

5.添加图书（核心代码）

// 1. 检测内容是否为空
var bookname = $('#bookname').val()
var author = $('#author').val()
var publisher = $('#publisher').val()
if (bookname === '' || author === '' || publisher === '') {
    return alert('请完整填写图书信息！')
}
// 2. 发起 ajax 请求，添加图书信息
$.post(
    'http://www.liulongbin.top:3006/api/addbook',
    { bookname: bookname, author: author, publisher: publisher },
    function(res) {
        // 3. 判断是否添加成功
        if (res.status !== 201) return alert('添加图书失败！')
        getBookList() // 4. 添加成功后，刷新图书列表
        $('input:text').val('') // 5. 清空文本框内容
    }
)

6.添加图书的Panel面板

  <div class="panel panel-primary">
    <div class="panel-heading">
      <h3 class="panel-title">添加新图书</h3>
    </div>
    <div class="panel-body form-inline">

      <div class="input-group">
        <div class="input-group-addon">书名</div>
        <input type="text" class="form-control" id="iptBookname" placeholder="请输入书名">
      </div>

      <div class="input-group">
        <div class="input-group-addon">作者</div>
        <input type="text" class="form-control" id="iptAuthor" placeholder="请输入作者">
      </div>

      <div class="input-group">
        <div class="input-group-addon">出版社</div>
        <input type="text" class="form-control" id="iptPublisher" placeholder="请输入出版社">
      </div>

      <button id="btnAdd" class="btn btn-primary">添加</button>

    </div>
  </div>

7.图书的表格

 <table class="table table-bordered table-hover">
    <thead>
      <tr>
        <th>Id</th>
        <th>书名</th>
        <th>作者</th>
        <th>出版社</th>
        <th>操作</th>
      </tr>
    </thead>
    <tbody id="tb"></tbody>
  </table>