您的位置:

Postman分享接口:方便简洁的API管理工具

Postman是一款RESTful API开发人员常用的chrome浏览器扩展插件,可以方便地进行HTTP请求的测试,支持各种API不同协议,比如GET、POST、PUT、DELETE、PATCH等,并且支持数据参数化,也可以轻松导出接口文档或者分享给团队成员。本文将从多个方面对Postman分享接口进行详细阐述。

一、首先,如何获取到Postman?

你可以在谷歌应用市场里面下载到:https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop

然后你会看到如下图所示的界面:


// 插件的关键方法,通过调用此方法自动安装插件。
function installPlugin() {
    if (window.chrome && chrome.webstore) {
        // 如果插件已安装,提示此时不需要重复安装。
        if (chrome.app.isInstalled) {
            alert('插件已存在');
            return;
        }

        chrome.webstore.install(
            "https://chrome.google.com/webstore/detail/fhbjgbiflinjbdggehcddcbncdddomop",
            function () {
                alert('插件安装成功!');
                console.log('插件安装成功!');
            },
            function () {
                alert('插件安装失败!');
                console.log('插件安装失败!');
            }
        );
    }
}

二、如何使用Postman分享接口?

1、首先需要在Postman中创建接口。

点击左上角的New按钮新建请求,如下图所示:

然后在弹出框中输入请求名称和URL地址,如下图所示:

2、调试验证接口

在Postman中验证API,可以根据需要对请求进行参数配置,调试请求是否返回正确的数据。

比如,下面我们模拟登录请求,配置请求参数:

然后点击“Send”按钮,进行请求测试。请求发送完成后,我们可以在Response面板中查看响应结果,如下图所示:

如果设置的参数有误,请求会返回错误信息:

三、如何导出接口文档?

在使用Postman管理API新建接口后,可以随时导出接口文档。导出的格式包括JSON、YAML和CSV等多种格式,方便后续与团队成员分享。

具体操作步骤如下:

1、在打开的接口列表中,勾选需要导出的接口。

2、点击右键,弹出上下文菜单,选择“Export”。

3、在弹出的对话框中,选择需要导出的格式以及保存的路径,如下图所示:

四、如何分享接口?

当你需要和其他团队成员协作开发API时,可以使用Postman分享接口的功能。具体操作步骤如下:

1、在打开的接口列表中,勾选需要分享的接口。

2、点击右键,弹出上下文菜单,选择“Share Collection”。

3、在弹出的分享对话框中,输入接受方的电子邮件地址,然后点击“Share”按钮提交请求。

4、接受方会通过邮件接收到分享链接,可以直接打开Postman并查看到分享的接口。

五、如何在Postman中使用数据驱动及环境变量?

据驱动功能可以极大的减小写测试代码的数量,减小维护测试代码的难度。而环境变量可以更好的管理和维护不同环境下的接口。

具体的步骤如下:

1、数据驱动

新建或编辑Collection,Postman支持在请求执行时读取CSV、JSON、XML等格式的数据文件,并使用读入的参数进行请求参数化,批量执行要自动化的API接口请求。以CSV格式的数据文件为例,创建如下图所示格式的数据文件:

然后在需要使用该数据的接口中导入该数据文件(可能需要先保存),在请求区块Parameters >> Body中使用{{variable_name}}语法引用读入的数据。

2、环境变量

环境变量类似于全局变量,可以储存在Collection或者请求中,并且在执行过程中可以被替换。

在使用Postman管理多个API接口时,API可能需要在不同的环境下运行,比如开发、测试和生产环境。我们可以通过设置多个环境变量,从而在不同的环境中覆盖不同的value值。

例如,可以设置一个名为“url”的环境变量,以储存API的URL值。然后在Collection中使用{{url}}的形式引用该环境变量,这样就可以方便地在不同的环境中切换API地址了。

六、如何使用Postman集成测试,并将结果和其他应用进行集成?

Postman集成了一下测试框架:

  • Chai
  • Mocha
  • Newman

可以通过集成测试框架进行API自动化测试。

具体操作步骤如下:

1、用Postman编写测试脚本。

在Postman中打开要测试的API,选择“Tests”选项卡,即可进入编写测试脚本的界面。测试脚本可以使用JavaScript语言进行编写,在测试脚本中可以通过请求的响应数据来验证API接口的正确性和是否返回正确的结果。下面是一个测试示例:


var jsonData = JSON.parse(responseBody);

tests["返回状态码是200"] = responseCode.code === 200;
tests["返回的消息体内容正确"] = jsonData.value === "hello world";

上面的示例测试脚本验证了请求是否返回了状态码为200的响应以及响应消息体是否正确。

2、导出测试结果。

在Postman中,通过选择“Runner”选项卡,进入Postman Runner界面,我们可以选择需要测试的Collection和Environment,并进行批量测试。测试完成后,点击右上角的“Export”按钮,即可将测试结果导出为HTML或JSON格式。

此外,Postman还提供了API,可以通过API获取测试结果以及集成到其他应用程序中,如CI/CD工具等。

七、总结

Postman是一个功能强大而方便的API管理工具,它支持多种方法、数据驱动、环境变量、测试并集成测试等众多功能。它为API的开发、测试和协作提供了简单且强大的工具。