api-test-bruno について
Brunoを使うチーム向けに、APIテストの計画と成果物作成を支援するスキルです。既知の情報に基づく実行可能なスモークアサーションを重視し、仮定や不足情報を明示します。
主な機能
- 01Bruno形式のAPIテスト作成
- 02エンドポイントと期待ステータスの必須化
- 03必要情報不足時の失敗成果物生成
- 04リスクに応じたシナリオの優先付け
- 05プレースホルダーや環境変数による認証情報管理
活用シーン
- 01既存のBrunoプロジェクト向けAPIテスト計画
- 02確認済みエンドポイントからのスモークテスト作成
- 03テスト要件に含まれる仮定や不足情報の特定
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ naodeng/ awesome-qa-skills --skill api-test-brunoインストール後、Claude Code で/api-test-brunoを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
README.mdagents/openai.yamlevals/eval.yamltrigger_queries.jsonevals/cases/basic-success.yamledge-bad-or-neighbor.yamledge-incomplete-input.yamlreview-repair-regression.yamlevals/fixtures/openapi-orders.yamlsample-curls.shevals/fixtures/scripts/check_bruno_output.shevals/graders/review-repair-regression.pyexamples/sample.curlsample.insomnia.jsonsample.openapi.yamlsample.opencollection.jsonsample.postman_collection.jsonsample.wsdlexamples/bruno/sample.bruexamples/ci/github-actions-bruno.ymlJenkinsfile.brunooutput-templates/template-markdown.mdprompts/api-test-bruno.mdreferences/framework-spec.mdgenerator-contract.mdreport-schema.mdsetup-and-ci.mdreferences/local/api-testing.mdscripts/api_case_contract.pycheck_bruno_report.py詳細
翻訳後に原文が更新されています。最新の内容は原文をご確認ください。
api-test-bruno(EN)
中国語版: 対応する中国語スキルを参照してください。
使用する場合
- API の出力を Bruno の構成やワークフローに取り込む必要がある場合。
- プロジェクトですでに Bruno を使用している場合や、Bruno ですぐに使える構成が必要な場合。
生成と実行の境界
ジェネレーターが生成するのは、既知のフィールドに対するスモークアサーションのみです。エンドポイントが空でないことと、expected_statuses が明示されていることが必須です。expected_json と、出典が明らかな max_response_ms は任意です。データの欠落、未解決のパラメーターや変数、スキーマアサーションがあると、不完全なひな形が生成され、終了コードはゼロ以外になります。references/generator-contract.md を読み、対象と認証情報を明示的に設定してください。
ワークフロー
- Progressive disclosure に記載されたメインプロンプトに従ってください(カバレッジ、構成、品質基準)。
- 結果に影響するプロジェクトのコンテキストのみを追加してください。対象範囲、環境、制約、リスク、依存関係、期待する成果物などです。
- 入力が不完全な場合は、まず使える初稿を提示し、前提と不足情報を明示してください。
- デフォルトでは Markdown を使用し、ユーザーから求められた場合にのみ形式を切り替えてください。
主な制約
- リスクやビジネスへの影響を基準に優先順位を付け、すべてを同等に扱わないでください。
- 確認済みの事実と現時点での前提を区別してください。
- ユーザーが提供していないエンドポイント、フィールド、環境、根本原因を作り出さないでください。
- 認証情報やシークレットにはプレースホルダーまたは環境変数の仕組みを使用し、実際の認証情報をハードコードしないでください。
- 出力は実行可能なものにしてください。具体的なシナリオ、明確な優先順位、明確な次のステップを示してください。
段階的な開示
- 出力を作成する前に、
prompts/api-test-bruno.mdを読み、その指示に従ってください(最低限のカバレッジ、出力構成、品質基準)。 - 既製のテンプレートが適している場合は、
output-templates/内の対応するファイルを使用してください。 - ユーザーが例を求めている場合や、既存のアセットとの整合性を求めている場合は、関連する
examples/を読んでください。 - フレームワーク、トラブルシューティング、スキーマに関する詳細を確認する場合は、
references/内の関連ファイルだけを読み、ディレクトリ全体を読み込まないでください。 - 形式変換や補助チェックには、独自に作り直すのではなく、既存の
scripts/を優先して使用してください。 - このスキルの評価やリグレッションテストには、skill-up とともに
evals/を使用してください。
提出前チェックリスト
- メインプロンプトの出力構成に従った
- 最低限のカバレッジとして、コレクション構成、環境設定、認証処理、優先度の高いエンドポイント、正常系シナリオ、異常系および境界値シナリオ、データまたは変数の戦略、アサーションの重点を確認した(詳細はメインプロンプトを参照)
- 最低限のチェックリストを網羅した、または省略した項目について説明した
- リスクの高い項目に優先順位を明示した
- ユーザーが提供していない詳細を作り出していない
- 前提と不足情報を明示した
よくある落とし穴
- 対象範囲やコンテキストが不足しているのに、完全な内容であるかのように見せないでください。
- すべての項目を同等に重要なものとして扱わないでください。
- 前提や情報の不足を見落とさないでください。
- 現在のツールチェーンに関係のない一般論を並べないでください。
コメント
Markdown 対応