2
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

Run in Postmanボタンを設定してコレクション共有を効率化しよう!

Last updated at Posted at 2024-04-22

はじめに

Run in Postmanボタンは、自分のコレクションを手軽に共有するための効果的な方法です。Run in Postmanボタンを関連するAPI仕様ドキュメントや開発者ポータルに載せておけば、API利用ユーザーはボタンを押すだけで、コレクションを簡単にPostmanのワークスペースにフォークしてAPIエンドポイントやリクエストの構造をすばやく確認したり実行したりすることができます。また、コレクションの提供者にとってもコレクションを共有する手間を省力化できます。

補足: フォーク(Fork)について

フォークとは、親要素の別ワークスペースへのコピーであり、親要素に変更を加えることなく変更できる新しいインスタンスのことです。Postman では、コレクション、環境、フロー(Postman Flows)をフォークできます。フォークはPostmanにおけるAPIコラボレーションを促進する利用者にとっても提供者にとても最強の機能です。

Screenshot 2024-04-22 at 12.21.57.png

フォークにより

  • 利用者はTime to first callが短縮化できる
  • 提供者は利用者からフィードバックが得られる

Run in Postmanボタンをクリックするとどうなる?

これは著者がパブリックに公開しているコレクションのAPIドキュメントページの例です。

Screenshot 2024-04-22 at 8.27.57.png

APIドキュメントにあるオレンジ色のRun in Postmanボタンをクリックすると、次のようなモーダル(左イメージ)が表示され、フォークの作成先ワークスペースを選択できます。

Screenshot 2024-04-22 at 10.03.27.png

Run in Postmanボタン追加方法

Run in Postmanボタンを追加するには、次の手順に従います:

(1) Postmanでコレクションを開きます。

(2) コレクションの右上にある「...」(詳細)ボタンをクリックして共有(Share)をクリックします。

Screenshot 2024-04-22 at 9.41.50.png

もし、共有元のコレクションがチームワークスペースにある場合は次のようなモーダルが表示され、公開先をチームなのかパブリックなのかを選択できます。共有元のコレクションがあるワークスペースのアクセス共有レベルによってこのモーダルの選択内容は異なります。

Screenshot 2024-04-22 at 10.34.45.png

(3) 「Postmanで実行」経由 (via Run in Postman)メニューを選択します。

Screenshot 2024-04-22 at 9.42.04.png

  • オプショナルで、埋め込むコードにコレクションとセットで環境を含めることができます。環境を追加(Add an environment)ドロップダウンリストを選択して、環境を選択してください
  • 埋め込みコードはHTMLフレンドリ(JavaScript, HTML, and CSSで構成)または、Markdownフレンドリを選択できます

以下、HTMLフレンドリとMarkdownフレンドリのサンプルコードになります。

HTMLフレンドリコード
<div class="postman-run-button"
data-postman-action="collection/fork"
data-postman-visibility="public"
data-postman-var-1="32477503-b4ed5b3f-4bdc-429c-a326-2f5832bbec4d"
data-postman-collection-url="entityId=32477503-b4ed5b3f-4bdc-429c-a326-2f5832bbec4d&entityType=collection&workspaceId=e7bccc60-56f2-4b2c-98fd-8cc4532662a2"></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>
Markdownフレンドリコード
[<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/32477503-b4ed5b3f-4bdc-429c-a326-2f5832bbec4d?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D32477503-b4ed5b3f-4bdc-429c-a326-2f5832bbec4d%26entityType%3Dcollection%26workspaceId%3De7bccc60-56f2-4b2c-98fd-8cc4532662a2)

(4) 提供されるコードをコピーして、Webページやドキュメントに貼り付けます。

これは、コレクション概要部分にMarkdownフレンドリコードを貼り付けた例です。
Screenshot 2024-04-22 at 8.27.57.png

より詳しい説明はRun in Postmanボタンに関する公式ページを参照ください。

以上です。

2
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?