简单介绍 "接口"

2022/1/28 6:06:13

本文主要是介绍简单介绍 "接口",对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!

@

目录
  • 1. 接口的概念
  • 2. 分析接口的请求过程
  • 3. PostMan 接口测试工具
    • PostMan 界面的组成部分
    • PostMan 测试GET接口
    • PostMan 测试POST接口
  • 4. 接口文档
    • 什么是接口文档
    • 接口文档的组成部分
    • 接口文档示例
      • 获取图书列表接口文档


1. 接口的概念

使用 Ajax 请求数据时,被请求的 URL 地址,就叫做数据接口(简称接口)。同时,每个接口必须有请求方式。
例如:
http://localhost:3006/api/getbooks 获取图书列表的接口(GET请求)
http://localhost:3006/api/addbook 添加图书的接口(POST请求)



2. 分析接口的请求过程

  1. 通过GET方式请求接口的过程
    在这里插入图片描述
  2. 通过POST方式请求接口的过程
    在这里插入图片描述



3. PostMan 接口测试工具

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

PostMan 的官方下载网址

PostMan 界面的组成部分

请添加图片描述

PostMan 测试GET接口

请添加图片描述

PostMan 测试POST接口

在这里插入图片描述



4. 接口文档

什么是接口文档

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


接口文档的组成部分

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

  1. 接口名称:用来标识各个接口的简单说明,如登录接口,获取图书列表接口等。
  2. 接口URL:接口的调用地址。
  3. 调用方式:接口的调用方式,如 GETPOST
  4. 参数格式:接口需要传递的参数,每个参数必须包含 参数名称参数类型是否必选参数说明这4项内容。
  5. 响应格式:接口的返回值的详细描述,一般包含 数据名称数据类型说明 这3项内容。

接口文档示例

获取图书列表接口文档

  • 接口URL: http://localhost:3006/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": "北京图书出版社" }
  ]
}



这篇关于简单介绍 "接口"的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!


扫一扫关注最新编程教程