Postman Collection と GitHub の連携 : POST/CON 25 の発表より
先日Postmanが開催している年次カンファレンスであるPOST/CON 25でいくつかの新機能がリリースされました。
中の人である川崎さんがそれぞれの機能のサマリーをXでポスト(Postmanだけに・・・やかましい、ごめんなさい)してくれています。それらを触っていこうと思います。第一回目はCollectionのGitHub連携です。
Collection と GitHub
Postmanには単独で、WorkSpaceというコラボレーション機能があります。一人の人間はかかわるプロジェクト毎に複数のWorkSpacesに所属することができ、同じワークスペースに所属している開発者同士がコラボレーションを行うことは可能でした。
しかしながらWorkSpaceをまたいだCollectionの共有には制限があり、一度JSONでエクスポートする必要がありました。
(ExportしたJSONのサンプル)
{
"info": {
"_postman_id": "76f09c0e-3cbd-43be-ad19-cd9f98d1cda1",
"name": "New Collection",
"schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json",
"_exporter_id": "13003149",
"_collection_link": "https://personal-6226.postman.co/workspace/Personal~acf0ba31-47c3-4e25-81e5-4e445d9d1054/collection/13003149-76f09c0e-3cbd-43be-ad19-cd9f98d1cda1?action=share&source=collection_link&creator=13003149"
},
"item": [
{
"name": "test.requestcatcher.com",
"request": {
"method": "GET",
"header": [],
"url": "test.requestcatcher.com"
},
"response": []
}
]
}
今回GitHub連携により、よりスムーズなCollectionの共有とコラボレーションが可能となりました。
さっそくやってみる
まずはCollectionからConnect Repository
を選択します。
GitHub
かGitHub Enterprise Server
から接続先を選択します。
確認画面が出ますのでContinue
をクリックします。
以下の画面になれば閉じて問題ありません。
画面を閉じてPostmanに戻るとRepositoryを指定する画面になります。
接続するGitHub Organization
を指定します。人によっては以下のダイアログが出ますが手順に従ってインストールを行います。
残念ながら画面が自動でリフレッシュされないため、インストールを行った方は再度GitHubへの接続を行うとOrganization
が選択可能となります。
その後レポジトリとブランチを指定すれば完了です。なお、ブランチは必須ですが、テスト用にレポジトリ作成直後はブランチが存在しませんので、READmeなどを作成してブランチを作っておきます。(mainで大丈夫です)
次にCollectionで適当なAPIコールを作成して保存すると、接続されているGitHubのブランチ名が出てきます。
コレクションの管理画面でもアイコンが表示されGitHubに繋がっているものは視認できるようになっています。
GitHub上では無事Collectionをエクスポートしたjsonが保存されています。
Discussion