在 Postman 按钮中创建运行

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

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

内容

在 Postman 中创建运行按钮

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

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

  • 在 Postman 中,打开您要共享的集合。

  • 在集合名称旁边,选择三个点图标以展开集合详细信息,然后选择共享集合以打开模式。

  • 在 Postman中切换到Via Run 。

  • 选择实时或静态按钮:

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

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

    • 静态按钮:此按钮使用 Markdown,因此您可以将其显示在 README、博客或其他 Markdown 文档中。
  • 您可以选择包含一个嵌入您的集合的环境。在左侧,选择环境下拉菜单并选择环境。

  • 选择复制图标 复制代码

在 Postman 按钮模式中创建运行

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

示例降价代码段:

[![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 API 中运行以创建和修改环境。

选择在 Postman 中运行按钮导航到可以将集合分叉到工作区的页面。将集合分叉到您的工作区将使您能够使用拉取请求为源集合做出贡献。如果您愿意,您还可以在公共工作区查看收藏,甚至可以使用屏幕上的链接导入收藏的副本。与新的 Run in postman 按钮共享的所有集合都带有Fork counts,可帮助您和您的消费者了解 API 的使用方式。

在邮递员中运行的叉子集合

Postman 中的 Live Run 按钮会随着原始收藏的更改自动保持更新,因此您的消费者始终可以获得您收藏的最新版本,而无需出版商手动更新收藏的链接。

下一步

阅读有关在 Postman API 中运行的更多信息,并了解如何使用按钮添加和更新环境。