跳至主要內容

Postman 集成

Postman 集成

版本要求: 2023.2.3

提示

由于历史原因,历史保存的持久化数据丢失了一部分字段,为了能够将同步至postman的数据更完整, 建议在插件postman配置中勾上保存后同步postman选项,通过保存操作来触发同步.

同时推荐使用该功能来同步api而不是导出

Postman API 用量问题

插件使用 Postman API 来同步数据，需要注意的是 Postman 同步涉及到 Postman API 的用量open in new window问题，点击链接需要注意 Postman API Usage 这一栏，每月最多免费使用 1000次。超过额度会导致同步失败！

postmanSync

Api key

Api key 用于使用 Postman 在线 API 执行一些手工行为.例如创建Collection、创建目录、创建 Request 等行为.

打开 https://postman.co/settings/me/api-keysopen in new window 并登录,并执行创建.注意最好是创建一个没有有效期的Api key.

postmanApiKey

WorkspaceId

Workspace id 是 Postman 工作空间的Id. 有2中策略来创建Workspace

  1. 每个项目来区分创建1个Workspace(推荐)
  2. 创建1个Workspace表示某个公司的,不同的Collection来表示公司下面不同的项目

获取WorkspaceId的步骤如下↓↓↓

a. 创建一个 Workspace,已有则忽略

createWorkspace

b. 点击 Workspace,并点击Workspace的info图标(注意不是点击Workspace Settings)

showWorkspaceId

c.复制得到Workspace id

workspaceInfo

Initial value 与 Current value

Environment 中变量的值包含 Initial value 和 Current value,Initial value是云端共享的,与之对应的Current value仅保留在本地. Postman中实际Request使用的是Current value.

但是,Restful Fast Request在对 Environment 同步的时候同步的是 Initial value.

所以如果插件中更新了 Environment 值,并且同步到了 Postman ,此时在 Postman 中执行 Request 并不会立刻使用同步的值, 而是需要在 Environment 中手工替换或者全部替换(点击Reset All).

workspaceInfo

前后置脚本

因为语言的不同,插件并不会同步前后置脚本.所以在使用插件的时候最好把一些共用的脚本写在项目级别配置中的前后置脚本,这样子也只需要在同步到Postman以后, 在Postman中的Collection级别下写前后置脚本.

postmanScript

注意事项

  1. 推荐勾选保存后即同步到Postman,如果没有勾选,则在手动触发的时候需要先保存,再点击同步
  2. 多方协作,如果发现同一个workspace出现多个相同的collection,只需使用其中一方的collection id在配置中手动替换即可
  3. 多方协作,如果发现同一个collection出现多个相同的folder,只需使用其中一方的.fastRequest/collections/ROOT/模块名/类名/directory.json中的pmFolderId属性即可
  4. 多方协作,如果发现同一个api在postman上有2份,则可以通过修改其中一份数据的pmRequestId和pmResponseId来是他们保持统一,可以通过 导航当前方法存储数据来定位存储的文件.最好的方式是通过git管理提交rapi文件使api底层存储数据保持一致
上次编辑于: