GraphQL クエリのテスト用 Playground

ワークフロー 内の各ジョブにある input ブロックは、GraphQL クエリの形で、検査/監査対象のデータを定義するものです。 同ブロックで利用する GraphQL クエリの記述の際には、以下の GraphQL クエリのテスト用 Playground (略称: GraphQL Playground) を利用できます:

• https://cloud.shisho.dev/[oid]/playground/query

note

[oid] はお使いの Shisho Cloud 組織の ID に適宜置換してください。

ユースケース: GraphQL クエリがスキーマに従うかをテストする

GraphQL クエリのテスト用 Playground は、ジョブの input ブロックが受理できる全ての GraphQL クエリを受理します。 Playground 上で試しに GraphQL クエリを実行することで、同クエリが現在 Shisho Cloud 上で利用できるか (例: シンタックスエラーがないか, 存在しないフィールドを参照していないか) を検証できます。

ユースケース: ポリシーへの入力として利用できるテストケースを手に入れる

記述したポリシーに対するテストケースが必要な場合には、Playground で出力された JSON フォーマットの結果を活用できます。 この際 Playground で返される値は、実際に Shisho Cloud 組織に連携された外部サービス上のデータではなく、テストを目的としたランダムな値 であることに注意してください。

danger

Playground で出力された JSON フォーマットの結果をopa コマンドなどのテストデータとして利用する場合、Shisho Cloud のポリシーコードが従うべき API の定義 に従ってデータを加工する必要があります。