ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

接口

2022-04-29 09:33:23  阅读:145  来源: 互联网

标签:调用 PostMan GET 接口 文档 请求


接口

1.接口的概念

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

例如:

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

http://www.liulongbin.top:3006/api/getbooks 添加图书的接口(POST请求)

 

2.分析GET方式请求接口的过程

(1)通过GET方式请求接口的过程

 

 

 (2)通过POST方式请求接口的过程

 

 

 

3.接口测试工具

(1)什么是测试工具

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

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

 

 

 

(2)下载并安装PostMan

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

 

 

 

 

 

(3)了解PostMan界面的组成部分

 

 

 

 

 

 

 

 

 

 

 

 

 PosMan界面的组成部分,从上到下,

从左到右,分别是:

菜单栏

工具栏

左侧历史记录与集合面板

请求页签

请求地址区域

 

(4)在PostMan使用GET发送请求

 

 

 

 (5)在PostMan使用POST发送请求

 

 

 

 

 

 

4.接口文档

(1).什么是接口文档

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

(2).接口文档的组成部分

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

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

接口URL:接口的调用地址

调用方式:接口的调用方式,如GET或POST。

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

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

返回示例(可选):通过对象的形式,例举服务器返回数据的结构。

3.接口文档的示例

 

 

响应格式:    
数据名称 数据类型 说明
status Number 200 成功;500 失败
msg String 对status字段的详细说明
data Array 图书列表
+id Number 图书id
+bookname String 图书名称
+author String 作者
+publisher String 出版社

 

 

 

标签:调用,PostMan,GET,接口,文档,请求
来源: https://www.cnblogs.com/0722tian/p/16204627.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有