【postman 高级功能二】参数化、报告生成，mock服务，连接数据库

1、 读取外部文件进行参数化

测试过程中，常会遇到一个接口要验证大量的测试数据，而输入参数又都是一样的。此时大家首先会想到数据参数化（数据驱动），在 Postman 中也提供了数据参数化功能，它需要把数据单独存放在一个文件中进行管理，然后通过读取这个文件，实现对所有数据的验证。

• 在本地电脑创建数据文件，支持数据格式文件分别为 csv 和 JSON。在文件中分别包括参数名和数据。

• 其中，在 Postman 中需要读取外部文件的参数名，通过参数名来获取文件中的数据；需要注意的是，在不同位置，其读取方式不同：
  在 URL 输入框，Params、Authorization、Headers、Body 的读取数据方式为：{{参数名}}。在 Pre-request Script 和 Tests 中读取数据方式为：data.参数名。

• ①创建 city.csv 或 city.JSON，格式如下：
  
  

• ②在请求中替换参数名：cityname。
  其中 cityname在 URL 中替换，故通过{{}}替换。
  citynameTests 中替换，则需要通过 data.cityname
  

• ③选择数据文件导入
  
  

2、生成测试报告

• Postman 生成测试报告需要一个插件：newman，需要注意的是，这个插件需要预先安装。
  安装 nodejs：
  newman 是由 nodejs 开发，所以要先安装它的运行环境，
  下载地址：http://nodejs.cn/download/，
  安装成功后需要验证：在 cmd 窗口中输入 node -v，如果输出 node 的版本信息，则证明安装成功。
  - 安装 newman：
  安装成功 nodejs 后，会自动安装一个包管理工具 npm(类似于 python 中的pip)。通过npm 就可以直接安装 newman，
  打开 cmd 窗口输入：npm install -g newman ，
  - 安装 newman-reporter-HTML：
  通过这个插件可以指定报告的生成路径和名称。
  同样打开 cmd 窗口输入：npm install -g newman-reporter-HTML，安装成功后进行验证：npm list -g --depth 0，如果能出现 newman-reporter-HTML 包及版本则证明安装成功。
  - 通过 newman 生成测试报告必须在 cmd 执行，命令执行：
  newman run [options] ，其中 options 中有很多参数，接下来我们来解析下这些参数。
  命令解析
• e : 可选，指定一个 URL 或者 Postman 的环境变量脚本文件。如果集合中指定了环境变量，则需要添加这个参数。
• g：可选，指定一个 URL 或者 Postman 的全局变量脚本文件，如果集合中指定了全局变量，则需要加这个参数。
• r：可选，指定测试报告的类型，如果想生成对应的报告类型，需要添加这个参数，典型的有 HTML、JSON、cli，若不添加，默认为 cli。
• -d：可选，指定一个数据参数化文件，如果有参数化文件，需要添加这个选项。
• –reporter-HTML-export：可选，指定生成报告的路径和文件名，如果不添加该参数，默认会生成一个 newman 的文件夹，里面存放着生成的测试报告。

newman run collect_a.JSON [-e environment_b.JSON] [-r HTML]
[--reporter-HTML-export report.HTML]

其中，[]内的参数是可选的。

案例说明

• ：通过 newman 生成测试报告，报告格式为默认：cli。

newman run A.Postman_collection.JSON -r cli // 默认的展示结果如下图所示。

• 案例 3：通过 newman 生成测试报告，需要添加环境变量文件，并且生成HTML 报告。

newman run B.Postman_collection.JSON -e test.Postman_environment.JSON-rHTML

• 通过 newman 生成测试报告，需要制定报告路径和文件名称。

newman run B.Postman_collection.JSON -e test.Postman_environment.JSON-rHTML --reporter-HTML-export report.HTML // 生成的测试报告会存放在当前路径下，报告名为：report.HTML

3、使用工作空间

4、集合同步与分支管理

5、编写接口文档

在做接口测试时，经常会碰到填写的请求数据不清楚这样的问题，这时，首先想到的就是接口文档。但很多时候，开发写的文档也不是很完善，更新也并不及时，亦或是更新了，大家也得跳出工具去找对应的接口文档，用户体验很不好。所以，现如今所出现的一些工具，既支持接口调试，同时，也支持文档查看，无需在工具和文档之间来回切换。Postman 也不例外，在 Postman 中，也是支持编写接口文档的，而且它的文档功能还非常强大。

5.1、生成文档(链接)

生成文档有两种方式，直接打开链接和新建 API 文档。

• 第一种：直接打开链接非常简单，首先，选择一个集合，然后，点击右三角-> 点击Viewinweb。
• 第二种，操作步骤如下：
  ①点击左上角的 New，选择 API Documentation
  ②弹出的第一个 Tab 页面，有两个选项，新建一个集合/从已有集合选择。这里，根据自己的实际需求来选择即可。
  ③进入到第二个 Tab 页面，输入对集合的一些基本描述，比如基本介绍、认证方式、错误码等。
  ④进入到第三个 Tab 页面，这时会弹出一个链接，直接点击链接，就会进入到接口文档页面。如下图所示：
  

以上两种方式，都可以进入文档链接，主要区别在于第二种可以加入一些整体性的说明，如系统概况、认证方式、错误码等。
另外，文档是以 Web 形式展现，所以相关查阅者只要知道这个链接，就都可以通过浏览器

5.2、编写文档

本地编辑步骤

①点击集合的右三角，会自动弹出 RUN 的窗口。
②选择一个请求点击后，会出现两个链接按钮，分别是 Add a description 和Open in builder。
③点击 Add a description，填写接口描述即可。

在线编辑步骤

①点击集合的右三角，会自动弹出 RUN 的窗口。
②点击 View in web，会在浏览器中自动打开该集合的 Web 链接地址。
③选择其中请求，点击 Add a description。
以上两种方式都可以给接口添加文档描述，且都支持 markdown 语法，编写好的信息也能及时的在文档中所看到，如下图所示是给某个接口添加的文档信息。

点击 Open in builder 这个链接按钮，也能直接打开对应的请求。
以下是以 Web 方式打开的在线文档，在线文档还有个比较实用的功能，就是为每个请求自动生成不同语言的代码，如果你刚好对如何用代码实现不太清楚，可以直接从这里拷贝

6、mock 服务

正常情况下，前端需要调用后端的接口才能完成一个完整的功能实现，但由于后端接口交付的延迟，严重影响了工作效率，这时，为了减少对后端接口的依赖，前端开发人员会创建一个 Mock 服务器，以模拟每个请求对应的响应。
Postman 支持创建 Mock 服务器。

6.1、创建 Mock 服务器

• 在 Postman 中最常见的创建 Mock 服务的方式有两种：通过 New 窗口创建和在运行面板中

6.1.1、New 窗口创建步骤

• ①点击 Mock Servers，点击+。
• ②需要为即将要创建的 Mock Server, 从已有的集合中为其选择某个集合，也可以基于创建的 Mock Server 重新创建一个集合。
• ③选择对应的 Mock 名称、环境等，然后，点击 Create Mock Server。
  
  

6.1.2、面板中创建

①选择集合，点击右边…，在弹出的面板中选择 Mock Collection。
②在弹出的界面中输入 mock server name、tag、environment，然后点击Create mock server，即可完成创建。
以上两种创建方式，最终结果都会在 Mock 标签中生成一个 Mock 服务器的链接，如下：

6.2 创建 Mock 请求

上文我们提到过，接口若不能准时提供给前端人员，就需要模拟对应的接口，但是模拟接口前，先要确定好接口的请求方法、请求路径、返回状态码以及响应数据。至于请求传递的参数则无需关注。所以，无论通过何种工具去模拟，至少需要用到以上几个参数。那么，通过 Postman 模拟请求，就需要用到 example。
接下来，就来了解下如何通过 example 模拟请求。

通过 example 实现模拟请求步骤：
①选择一个请求，发送请求通过后，点击 Save Response 中的 Save as example。②这时，会自动弹出一个 tab 页，这个页面其实就是 Postman 的 example，也就是接下来要说的模拟请求。
③在弹出的 example 页面，需要将请求方法、请求路径、响应状态码以及相应的数据填写好，然后点击右上角的 Save Example。
④保存成功后，就能在右上角看到要保存的 example 了。
⑤以上步骤相当于创建好了一个模拟请求，接下来就可以通过工具请求这个example(模拟请求)了。在 Postman 打开一个新的 tab 页，请求方法填写保存好的example 的方法，请求地址要填写 Mock 服务器地址+请求路径，点击 Send，就会将预期结果返回。

7、连接数据库

对于接口测试，其很重要的一个环节就是要连接数据库，那么对于Postman 而言，是否也可以进行连库操作呢？答案是肯定的。但此处，需要用到一个插件：xmysql。通过 xmysql 连库后，xmysql 会将数据库中所有表以 REST 风格的接口形式生成，所以后续访问某张表其实就是访问的某个接口，那么对于 Postman 而言，其实也就是相当于访问了某个接口而已。

7.1、安装

①安装 nodejs：
xmysql 是由 nodejs 开发，所以要先安装它的运行环境，下载地址：http://nodejs.cn/download/。
②安装成功后需要验证：
在 cmd 窗口中输入 node -v，如果输出 node 的版本信息，则证明安装成功。
③安装 xmysql：
安装成功 nodejs 后，会自动安装一个包管理工具 npm(类似于 python 中的pip)。通过它就可以直接安装 xmysql。打开 cmd 窗口输入：npm install -g xmysql。

7.2、连接数据库

xmysql 命令参数介绍：

-h 连接数据库主机名
-u 连接数据库用户名
-p 连接数据库密码
-d 连接数据库名
-r 连接数据库输入的主机名，无这个选项默认为 localhost
-n 连接这个服务设置的端口，无这个选项默认为 3000

xmysql -u username -p password -d databasename

以下为连接本地数据库的示例，注意：在输入下图红框中的这条命令后，xmysql 会以服务的形式启动。所以，当 xmysql 被停止掉，那么连库操作也会失败。