Postmanでチームコラボレーション！

実は、PostmanにはチームでAPI開発やテストを行うためのコラボレーション機能がたくさんあります。知っておくと作業がとても効率的になる機能と、チームでの作業ワークフローのベストプラクティスをお話しします。Postman Tokyo Meetup 2024.2での発表資料です。

Transcript

1. All rights reserved by Postman Inc Postman で チームコラボレーション！ 草薙 昭彦 テクノロジーエバンジェリスト #PostmanMeetup
2. テクノロジーエバンジェリスト Postman 株式会社 草薙 昭彦 @postman_japan @nagix
3. 提供者・利用者間 コラボレーション API 提供者 コラボレーション API 利用者 コラボレーション API ライフサイクル @postman_japan
4. よくある Postman コレクション共有方法 @postman_japan ユーザー A ユーザー B コレクション （JSON ファイル） エクスポート インポート エクスポート インポート エクスポート インポート ：
5. グループ （要 Enterprise プラン） チームで Postman を使うときの要素 @postman_japan チーム ワークスペース ロール
6. チームと チームワークスペース @postman_japan
7. ワークスペースとは？ ワークスペース内のコレクション、API 定義、環境、モック、モニターなどへの共有アクセスをチームや世界 に提供し、組織や世界をまたいだシームレスなコラボレーションを支援するコラボレーションハブ ワークスペース（パブリック） ワークスペース内の コレクション群 ワークスペース コレクション API (API ビルダー) 環境 フロー @postman_japan
8. ワークスペースとは？ 5 種類のワークスペースがあり、それぞれ異なる共有アクセスレベルを提供します パーソナル 自分だけがアクセス可能 プライベート ワークスペース作成ユーザーとそのワークスペースに招待されたチー ムメンバーのみアクセス可能。要 Professional プラン パートナー ワークスペース作成ユーザーとそのワークスペースに招待されたチー ムメンバー、およびパートナーとして招待した外部ユーザーのみアクセ ス可能。要 Enterprise Ultimate プラン チーム 全てのチームメンバーだけがアクセス可能。設定可能なチームメン バー数はプランによって変わる（Free プランは 3 名まで） パブリック 世界中の誰もがアクセス可能。パブリック API ネットワークに API を公 開するにはワークスペースをパブリックする必要がある ワークスペースの種類 @postman_japan
9. チームとは？ • Postman チームとは、コレクション、API ドキュメント、モニターなどを共有し、共同作業を行う社内 の開発者、テスト担当者、その他関係者の集団を表します ◦ 通常、組織全体のコラボレーションと一貫性を促進するために、組織には1つの Postman チームインスタンスを作って運用します • ユーザーは、複数のチームに所属することができますが、Postman 利用時にはチームを切り替え て利用します • チームをまたいで Postman の要素を共有したり、フォークをすることはできません （外部ユーザーの招待やパブリックワークスペースは例外） @postman_japan
10. チームへの所属の遷移 アカウントは複数のチームに所属できる／チームに所属しない個人アカウントという状態がある @postman_japan サインアップ 個人アカウント （初期状態） チームAを作成 チームAアカウント チームAからの招待 チームBからの招待 チームA / チームB アカウント チームAから退去 個人アカウント （チーム退出後） 個人 / チームA アカウント 個人アカウントで作成した すべてのワークスペースは チームA所属となる 個人アカウントとチーム Aを切 り替えて利用できる パーソナルワークスペースは別の チームメンバーに移管する 最後のチームメンバーだった場合の み個人アカウントに持ち出せる
11. ワークスペースを使ったコラボレーション @postman_japan ユーザー A ユーザー B チームワークスペース 他のメンバーもアクセス できる場所で直接読み書き または コメントをつける
12. フォーク、プル、マージ 変更の追跡 @postman_japan
13. 同時に編集！？ @postman_japan チームワークスペース
14. コレクションのフォーク・プル・マージ @postman_japan ユーザー A の ワークスペース チームワークスペース ユーザー B の ワークスペース フォーク プルリクエスト* マージ フォーク コンフリクトの解消 プルリクエスト* マージ プル 変更通知 *パーソナルワークスペースからのプルリクエストは作成できないので注意
15. フォークとは？ フォークとは、親要素の別ワークスペースへのコピーであり、親要素に変更を加えることなく変更できる新 しいインスタンスのことです。Postman では、コレクション、環境、フロー (Postman Flows) をフォークで きます。フォークは Postman における API コラボレーションを促進する、利用者・提供者の両方にとって 便利な機能です。 親コレクション 子コレクション ② 親コレクションの更新・ 変更に関する通知、プル ① フォーク ③ 親要素に対してフィードバック • コメント • プルリクエスト、マージ フォークにより • 利用者は Time to first call が短縮化できる • 提供者は利用者からフィードバックが得られ る @postman_japan
16. プルとマージ @postman_japan • フォーク元の親コレクションの変更部分を、 フォーク先の子コレクションで更新（ プル）し ます ◦ 実行前に、親コレクションにおける変 更部分を確認できます • フォーク先の子コレクションの変更部分を、 フォーク元の親コレクションにマージします ◦ 双方の変更部分を確認し、コンフリク トの確認や、マージ方法の選択がで きます
17. 差分の確認 @postman_japan
18. プルリクエスト @postman_japan
19. プルリクエスト @postman_japan • フォーク先での変更を直接マージするのではなく、 プルリクエストを作成して変更をレ ビュー担当者が確認した後にフォーク元にマージするプロセス • プルリクエストにはタイトル、説明、レビュー担当者のユーザーを入力 • プルリクエストに対しては、承認の件数、ウォッチの件数が表示され、更新やコメントの 通知を行うかどうかの設定を行える • レビュー担当者は、マージ元の閲覧権限、およびマージ先の編集権限が必要 ◦ つまり、パーソナルワークスペースからプルリクエストは作成できない • レビュー担当者には通知が行われ、プルリクエストに対して承認、編集、拒否の操作 ができる • レビューの条件設定は Professional プラン以上で
20. コンフリクトの解消 @postman_japan • コンフリクト: フォーク元とフォーク先で同じ部分に異なる変更が存在 • マージ元の変更を保持するか、マージ先の変更を保持するかを、個別に選択するか、全体 で選択してコンフリクトを解消する
21. ベストプラクティス @postman_japan • 直接のマージは、コンフリクトの対策にはなるが、品質向上には繋がらないので、プル リクエストのプロセスを採用すべき • プルリクエストのレビューには、マージ元の閲覧権限も必要であるため、チームワーク スペースにフォークを作るべき ◦ フォーク元と同じワークスペースである必要はないため、個人用のチームワーク スペースを作ってフォークするのも良い • プルリクエストの承認条件を設定するには Professional プランが必要 ◦ ワークスペース／コレクションごとにマージできるユーザーを制限 ◦ 最低限1つの承認／マージできるユーザーの承認が必要になるように設定
22. ロールとグループ @postman_japan
23. チームとグループ 基本的に共有はチーム内で行われるため、企業＝チーム チーム チームワークスペース プライベートワークスペース ユーザー ユーザー ユーザー グループ ユーザー ユーザー ユーザー 編集者ロール 管理者ロール 編集者ロール 閲覧者ロール 管理者ロール 会社全体で共有したいコレクショ ンや環境など 部門やプロジェクト単位で共有した いコレクションや環境など グループ ユーザー 閲覧者ロール ユーザー 管理者ロール ユーザー 開発者ロール コミュニティマネージャーロール ロールの詳細は： https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/
24. 各プランで利用できるコラボレーション機能 Free Basic Professional Enterprise Essential Enterprise Ultimate チームメンバー数 3 上限なし 上限なし 上限なし 上限なし プライベートワークスペース ✔ ✔ ✔ チームワークスペース ✔ ✔ ✔ ✔ ✔ パートナーワークスペース ✔ パブリックワークスペース ✔ ✔ ✔ ✔ ✔ プルリクエストの承認設定 ✔ ✔ ✔ スーパー管理者ロール ✔ ✔ コミュニティマネージャーロール ✔ ✔ ✔ パートナーマネージャーロール ✔ パートナーロール ✔ ゲストロール ✔ ✔ ✔ 要素の編集者／閲覧者ロールの区別 ✔ ✔ ✔ グループ ✔ ✔ @postman_japan
25. ダウンロードして無料でスタート！ https://www.postman.com/downloads/ デスクトップアプリ • Windows • Mac • Linux Web アプリ • アカウント登録で同 じ機能をブラウザで も利用できる @postman_japan
26. @postman_japan ご清聴いただき、ありがとうございました