使用postman-cli工具管理Postman数据

背景

使用Postman的Collection时，会将多个请求合并在一个文件夹内，显示出清晰的逻辑，但是对已经存在的请求重新分配文件夹比较困难。

解决办法

Postman支持将Collection导出为collection.js。所以我们可以简单的去修改Json文件以达到修改Collection内请求分组的目的。又导入导出时一件很麻烦的事情，所以我们使用一个辅助工具 matt.ball/postman-cli 来帮助修改。

matt.ball/postman-cli

基础

工具操作的对象为Collection，作用是将Postman应用中指定的Collection在本地创建对应的Json或Js文件，并在本地的修改同步到Postman应用中。

以一个文件夹作为一个仓库，会将指定的配置保存在.postman.json文件中。

命令说明

➜ postman -h
Usage: index [options] [command]

Options:
  -h, --help  output usage information

Commands:
  setup       Configure Postman CLI for first use
  bootstrap   Generate local files from Postman Collection
  sync        Sync local files to Postman Collection
  update      Update collection in the Postman app
  clone       Clone collection into My Workspace

命令	说明
postman setup	设置初始参数
postman bootstrap	从Postman应用生成本地文件
psotman sync	将本地文件同步到Postman修改
postman update	在Postman应用中更新Collection
postman clone	将本地的Collection在My Workspace克隆一份

使用

0. 环境

工具需要node.js为运行环境，所以先安装node.js环境。此处不再赘述。

1. 安装

全局安装

yarn global add @matt.ball/postman-cli

2. 初始设置

选择一个文件夹作为仓库地址，在该目录下执行postman setup命令并设置对应参数。完成后会在目录下生成文件.postman.json。

postman setup

3. 将Postman中Collection在本地生成文件

执行命令postman bootstrap。

postman bootstrap

生成文件夹结构应如下:

├───postman
│   ├───对应Collection下的文件夹结构
│   ├───这是一个文件夹（Folder）
│   │   └───这是一个接口
│   │       ├───request.json
│   │       ├───response.json
│   │       ├───prerequest.js
│   │       └───tests.js
│   ├───更多的文件夹...
│   ├───prerequest.js
│   └───tests.js
├───.postman.json
└───postman_collection.json

对应的接口会是一个文件夹，包括请求和响应，如果设置了Pre-Request或Tests这两快内容会是以js文件的形式。postman_collection.json则包含了Collection中的文件组织，修改这部分可以到达移动接口到文件夹的需求。

4. 将修改同步回Postman应用

执行命令：

postman sync