3.postman与接口文档

这篇具有很好参考价值的文章主要介绍了3.postman与接口文档。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

数据接口简称接口,是被请求的url地址

目录

1  postman

1.1  下载

1.2  创建工作站

1.3 请求 

1.3.1  工作站中创建请求

1.3.2  带查询字符串的请求

1.3.3 默认带参数的post请求

1.3.4  发送JSON的请求

1.3.5  发送带Authorization请求头的请求

1.4  删除工作站

1.5  整理请求

1.5.1 创建组

1.5.2 删除组 

1.5.3  在组中添加请求 

1.5.4  将写好的请求保存到组中

2  接口文档


1  postman

postman是接口测试工具,接口测试工具是用来模拟请求的,postman官网 Postman

1.1  下载

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

点开后会出现一个页面让你登录,登录之后就能用了

1.2  创建工作站

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

1.3 请求 

1.3.1  工作站中创建请求

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

点击之后选择请求方式,输入你要访问的路由与要发送的数据,点击send后,在最下方会显示响应内容

1.3.2  带查询字符串的请求

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

  • post请求也可以带查询字符串请求

1.3.3 默认带参数的post请求

如果用post发送数据就要在Body中的x-www-form-urlencoded中填写数据

  • x-www-form-urlencoded是post默认的Content-Type

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

1.3.4  发送JSON的请求

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

1.3.5  发送带Authorization请求头的请求

在我们使用token的时候会使用到请求头 Authorization

使用Bearer Token不用把Bearer写在Token内容的开头

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

或者也可以放在 Headers 中发,在 Headers 中发就需要带Bearer 了

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

1.4  删除工作站

点击左上角可以查看我们当前已有的工作站

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

我们现在想把test这个工作站删掉,那么我们首先进入test工作站

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

点击Workspace Settings

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

点击Delete Workspace

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

输入工作站的名字,然后点击删除

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

这样test工作站就没有了

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

1.5  整理请求

当要测试一个项目的时候,接口量比较大,如果都堆在顶部会很不方便,这个时候我们可以使用collections功能

1.5.1 创建组

这样可以建立一个请求组,在铅笔图标的位置可以修改名字

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

1.5.2 删除组 

这样是删除这个组

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

1.5.3  在组中添加请求 

点击这里可以添加请求

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

可以在这里修改名字

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

1.5.4  将写好的请求保存到组中

之前通过加号添加的请求,想添加的组中,点击这里的save

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

选择要保存到的组

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

2  接口文档

接口文档是接口的说明文档,接口文档应该包含

  • 接口名称
  • 接口url
  • 调用方式 像GET、POST这些
  • 参数格式 包含参数名称,参数类型,是否必选,参数说明
  • 响应格式 接口的返回值情况,包含数据名称,数据类型,说明
  • 返回示例

这个是接口文档的样子

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

postman写接口文档,Ajax笔记,一些常用软件的操作,postman

这个是接口文档的md文件内容文章来源地址https://www.toymoban.com/news/detail-557897.html

# 图书列表
- 接口URL : http://www.liulongbin.top: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": "北京图书出版社"
        }
    ]
}
```

到了这里,关于3.postman与接口文档的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 【软件测试学习笔记6】Linux常用命令

    command  [-options] [parameter] command 表示的是命令的名称 []表示是可选的,可有可无 [-options]:表示的是命令的选项,可有一个或多个,也可以没有 [parameter]:表示命令的参数,可以有一个或多个,也可以没有 绝对路径:唯一 /开头    cd/etc/abrt ~/开头  cd/usr/bin ~就是/home/用户  

    2024年01月21日
    浏览(41)
  • 软件测试学习笔记丨docker 搭建常用服务器与平台命令

    本文转自测试人社区,原文链接:https://ceshiren.com/t/topic/29881 映射端口 : docker run -d -p 5003:80 --name mynginx nginx (5003是宿主机,80是容器端口) 映射文件 : docker run -d -p 5003:80 -v \\\"$PWD/html\\\":/usr/share/nginx/html --name mynginx nginx -v : 文件映射 docker run --name some-mysql -v /home/gaofei/test/mysq

    2024年03月13日
    浏览(51)
  • 3.postman与接口文档

    数据接口简称接口,是被请求的url地址 目录 1  postman 1.1  下载 1.2  创建工作站 1.3 请求  1.3.1  工作站中创建请求 1.3.2  带查询字符串的请求 1.3.3 默认带参数的post请求 1.3.4  发送JSON的请求 1.3.5  发送带Authorization请求头的请求 1.4  删除工作站 1.5  整理请求 1.5.1 创建组

    2024年02月15日
    浏览(26)
  • postman自动生成接口文档

     点击:  会自动生成一个文件夹    点击图表,修改名字 新建一个请求,到时候会自动保存到文件夹里面,但是保存前看清楚保存的名字    点击三个点-》点击export即可

    2024年02月11日
    浏览(35)
  • swagger接口文档导入postman

    第一步:打开接口文档并且打开控制台: 第二步:点击Network,找到api-docs的文件  第三步:将JSON格式的数据保存到本地  第四步:打开Postman,并且点击右上角的Import  第五步:将刚才的JSON格式数据粘贴复制到Raw Text  第六步:点击Continue,执行POSTman的默认选项,并且点击

    2024年02月13日
    浏览(35)
  • API接口文档利器:Swagger 和 接口调试利器:Postman

    2.1.1Swagger介绍 Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务 (https://swagger.io/)。 它的主要作用是: 使得前后端分离开发更加方便,有利于团队协作 接口的文档在线自动生成,降低后端开发人员编写接口文档的负担 功能测试 Spring已经

    2024年02月11日
    浏览(30)
  • postman导入json格式的接口文档

    Download Postman | Get Started for Free   点击下载,等待下载完成即可 双击安装,等带安装完成 注意:这个功能必须登录才能使用 1. 点击import 2. 点击files,弹窗选择文件   选择后缀是json的文件即可    最终的效果如上图 接下来就可以掉调用接口了

    2024年02月15日
    浏览(35)
  • 1.10 实战:Postman生成在线接口文档

    对于接口测试,最最关键的一个部分,就是接口文档,有了详细的接口文档,我们才能根据接口文档去写好我们的接口测试用例以及写好我们的接口自动化测试。目前比较常用的接口文档是两种方式 Swagger 我们看一下Swagger的官网的例子就可以看到它有多方便了。我们打开RE

    2024年02月05日
    浏览(34)
  • Postman工作协同:生成接口文档和示例,超实用

    Postman这个Documentation功能对于前后端分离的团队,接口开发团队来说真的是提升沟通效率和工作效率的一个利器。废话不多说,直接上干货来看如何通过Postman来生成接口文档和发布接口文档,以及如何定制化文档中的内容。 定义一套接口,为接口生成文档和示例一般来说有以

    2024年02月14日
    浏览(23)
  • 接口测试--Postman常用断言

    Postman的断言是用javascript语言写的 结果中的特定属性或值与预期做对比,如果一致,则用例通过,如果不一致,断言失败,用例失败。断言,是一个完整测试用例所不可或缺的一部分,没有断言的测试用例仅仅是测试步骤。 ​  解释: pm是一个全局对象,代表了postman运行时的环

    2024年02月07日
    浏览(38)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包