跳到主要内容

创建 Run in Postman 按钮

共享 Postman 集合的 一种方法是创建一个独立的Run in Postman按钮。Run in Postman按钮 在 Postman 按钮中运行 允许用户 Forking 集合。你可以将按钮嵌入你的网站或自述文件中,让开发人员更快地与你的 API 交互。

作为用户,你仍然可以使用 OpenAPI 和 RAML 等 API 规范格式创建“在 Postman 中运行”按钮。要为你使用的标准创建按钮,请首先通过将文件 导入 Postman 或通过 从你的 API 生成集合来 将文件转换为集合。

在 Postman 按钮中创建运行

确保你已登录到你的 Postman 帐户,并且你在公共工作空间中有一个要共享的集合。

注意:如果集合存在于公共工作空间中,你可以直接将复制的代码嵌入到你希望显示按钮的位置。如果集合存在于团队或个人工作空间中, 请将集合共享到公共工作空间 以创建“在 Postman 中运行”按钮。

  1. 在边栏中选择收藏集,然后选择你要共享的收藏集。

  2. 在集合名称旁边,选择更多操作图标 更多操作图标 ,然后选择共享

  3. 选择通过在 Postman 中运行选项卡。

  4. 选择一个实时或静态按钮:

    • 实时按钮- 此按钮使用 JavaScript、HTML 和 CSS,因此你可以为网站自定义按钮。你还可以访问 Run in Postman API 以动态创建和更新环境。

    要创建实时按钮,你需要将集合共享到公共工作空间。如果你没有要共享的公共工作空间,则可以使用模式创建一个新工作空间。对于企业计划的用户,你需要具有 社区管理员 角色才能 创建新的公共工作空间

    • 静态按钮- 此按钮使用 Markdown,因此你可以在自述文件、博客或其他 Markdown 文档中显示它。
  5. 你可以选择包含一个环境以嵌入到你的收藏中。选择添加环境下拉列表并选择环境。

  6. 选择 复制图标 复制代码

    在 Postman 按钮模式中创建一个运行

    你的嵌入代码将包含你收藏的 ID。在下面的示例中,:collection_id是该 ID 的占位符,而:collection_url是 url 的占位符。如果你选择在按钮中包含一个环境,代码也将具有环境参数。

  7. 将代码嵌入你希望按钮显示的位置。

    在Postman 中运行

示例 Markdown 片段

 [![Run in Postman](https://run.pstmn.io/button.svg) ](https://god.gw.postman.com/run-collection/:collection_id)

示例 HTML 片段

<div class="postman-run-button"
data-postman-action="collection/fork"
data-postman-var-1=":collection_id"
data-postman-collection-url=":collection_url"></div>
<script type="text/javascript">
(function (p,o,s,t,m,a,n) {
!p[s] && (p[s] = function () { (p[t] || (p[t] = [])).push(arguments); });
!o.getElementById(s+t) && o.getElementsByTagName("head")[0].appendChild((
(n = o.createElement("script")),
(n.id = s+t), (n.async = 1), (n.src = m), n
));
}(window, document, "_pm", "PostmanRunObject", "https://run.pstmn.io/button.js"));
</script>

使用 Run in Postman 按钮

选择“在 Postman 中运行”按钮以打开你可以将集合派生到工作空间的页面。 将集合 Forking 到你的工作空间将使你能够使用拉取请求为源集合做出贡献。如果愿意,你还可以在公共工作空间中查看该集合,甚至可以使用屏幕上显示的链接导入该集合的副本。使用新的Run in Postman按钮共享的所有集合都带有 Fork counts ,这有助于你和你的消费者了解开发人员如何使用 API。

在Postman 中运行的叉子集合

Postman 中的实时运行按钮会自动与原始集合中的更改保持更新,因此你的消费者始终可以获得你的集合的最新版本,而发布者无需手动更新集合的链接。