Open18
Postman Flowsの使い道
Postman
Postman flowsを使ってみることを考える
カタログはどんな感じ
- 3K ぐらい(2023.11.21現在)
まだそんなにない
チュートリアル
チュートリアルはこれ
参考資料
クラスメソッドさんのが参考になる
API定義はしっかりしないと作れない
APIのCollections はfork元
Gallerry
ここを見よう
現状ではまだPostman公式が頑張っているぐらい
Public Collection などと連携して、flows を提供しているところはあるのか?
非公式GitLab APIコレクション
これで flows組むのもあり?
将来はこうなってほしい
※公式にも書いてある
- APIの複雑なフローを可視化する設計書位置付け
- カスタマーサポートなど、サポートデスクが気軽に使える機能として
- API作るまででもないんだけど、いつも問い合わせ来る時にちょっと叩くのに
- ログインしたり、手順が多くて、複雑なフローはなかなかできない
- 折角なんでUIフォームがノーコードで作れるとnobis には良さそうなんですよね
- 日本製の製品のカタログ含めて増えて欲しい(APIベンダーさんへのお願い?)
- Collection のように階層構造が作れるとグルーピングできて嬉しい(できる?)
- flows が plantuml とかシーケンス図からimport できるとかexport できると嬉しい
- 作ったflowsをAPIで叩きたい(Webhook作れる)
作ってみよう
- シーケンス図に沿って作る
- 例えばInstagramとか面倒そうなものを検討する
まだPostbot は flows を書いてくれない
叩き台で良いので作ってくれると嬉しいなぁ
追加でお金かかるよ
Backlog のwikiを取得するFlows(Postman x Momento x Backlog x Markdown Backup )
やりたいこと
- Backlog を他のところからコピーしてきて、GitLab Wikiに転写する
- BacklogからMomento にデータを一時的に書き込み保存する
- TTL切れた場合は再取得する
- Markdown Backupは GitLab CI から Momento CLI を使用して行う。つまりGitLab CI 上ではキャッシュデータのみを扱う(Backlog へのダイレクトアタックはCIからは避ける)
やらないこと
- Momentoへの事前登録済みキャッシュの確認フローの構築(しっかりやる場合はやっておかないといけない)
- TTL の更新
事前準備
- Backlog のAPIキーを取得しておくこと
- Momento Cache を作っておくこと
手順
- Projectを取得する
- ProjectのWikiの一覧を取得する
- Wikiのコンテンツを取得する(同様にコメント、添付ファイルなども取得するとばっちり)
出来たもの
取得したWikiをMomento につっこむ
JSONで扱いたいので、Collectionを duplicated して中身を個別に切り出して扱う。処理固有なので、専用のCollectionを用意しないと元々の方が壊れる(こういうの増やさないで扱う方法あれば、もっと楽にバリエーション増やせそうなんだけど、example でもダメなんだろうなぁ)
全体像
増やしたコレクション
- Backlogはないので使いそうなAPI定義を作って、登録
- Momento はFlow用に複製した方がいい
GitLab CI でキャッシュを取り出す
T.B.D.
課題
- Flows を編集中に使用しているCollectionをいじったら、Workspaceを変えるなどして、一度、キャッシュを削除する必要がある。どうも一度Run すると読み込まれてしまっているため、リロードしても動かない様子。
Postman Flow とは関係ないけど
ガイドライン作った方が良さそうだな