GIHOZアップデート情報：GIHOZからテストケースなどのデータを取得するAPIの公開

日頃からテスト技法ツールGIHOZをご利用いただき誠にありがとうございます。

最新のアップデート情報をお知らせします。

GIHOZで作成したテストケースなどのデータをAPIで取得できるようになりました！

これまではGIHOZで作成したテストケースなどのデータを取得するには、GIHOZの画面を開きCSVダウンロード等の操作をしていただくしかありませんでしが、今回のアップデートによりAPIでデータを取得できるようになりました。これにより、GIHOZで作成したデータを他のツールやプログラムから利活用しやすくなります。

APIを利用するには、まずAPIトークンを生成します。画面右上のユーザアイコンをクリックし、「APIトークン」を選択することで、APIトークン生成画面を開くことができます。「トークン生成」ボタンをクリックして新しいAPIトークンを生成します。手順の詳細はGIHOZのヘルプページをご参照ください。生成したAPIトークンは、他の人に見られないように安全に保管してください。

APIトークンをBearerヘッダーに含めてHTTPリクエストを送ることでGIHOZのAPIを利用できます。特定のテストケースのデータを取得したい場合、curlコマンドであれば以下のように実行します。{owner_name}はリポジトリを作成したユーザのユーザID、{repository_name}はリポジトリ名、{test_case_uuid}はテストケースのUUID、{api_token}はAPIトークンに置き換えてください。

$ curl 'https://gihoz-api.veriserve.co.jp/api/v1/users/{owner_name}/repositories/{repository_name}/test_cases/{test_case_uuid}' -H 'Authorization: Bearer {api_token}'

APIの詳細は以下のドキュメントをご確認ください。

GIHOZ API仕様

実際にテストケースをAPIで取得すると、以下のようなJSON形式のデータが得られます。

test_case_jsonの文字列は、改行コード（\n）と、ダブルクォーテーションのエスケープ文字（"記号の前の\記号）を取り除けばJSONとしてパースできます。GIHOZで作成したテストケースのデータを、他のプログラムやスクリプト等でJSON形式のデータとしてご利用いただけます。例として、GIHOZのテストケースのデータをテスト管理ツールの入力データ形式に変換し、テスト管理ツールのAPIでテストケースを投入する、といった連携が可能となります。

ぜひ、皆さまが利用されているGIHOZ以外のツールと連携させてご利用ください。

今回は、GIHOZからテストケースなどのデータを取得するAPIの公開についてお伝えしました。テスト技法を使って設計したテストモデル・ケースを、JSON形式で取得できるツールは珍しいのではないでしょうか。ぜひいろいろな活用方法をご検討いただき、ご利用いただければと思います！

APIやデータ形式についてのご意見・ご要望がありましたら、GIHOZの画面右上のフィードバックアイコンから、ぜひともフィードバックをお送りください。