Skip to main content

テスト可能なドキュメント例

このページは、実際のテストエージェントに対して動作する完全なコード例を使い、テスト可能なドキュメント機能を紹介します。

JavaScript の例

クリエイティブフォーマットの一覧取得

Python の例

クリエイティブフォーマットの一覧取得

CLI の例

uvx (Python CLI) の使用例

テスト可能なドキュメントの仕組み

フロントマターに testable: true を設定すると、このページ内のすべてのコードブロックが抽出され、テスト時に実行されます。

テストの実行

テスト可能ページの要件

すべてのコードブロックは次を満たす必要があります。
  • 完結しており自己完結していること
  • 必要な依存関係をすべてインポートしていること
  • エラーなく実行できること
  • 成功を確認できる出力を生成すること

ページをテスト可能とマークするタイミング

ページに testable: true を付けるのは、次の条件をすべて満たす場合に限ります。
  • すべてのコードブロックが完全な実行例です
  • コード断片や不完全なスニペットがない
  • すべての例がテストエージェントの認証情報を使用しています
  • 依存関係がインストール済みである(@adcp/client, adcp

ページをテスト可能としない場合

次のようなページに testable: true を付けてはいけません。
  • パターンを示すだけのコード断片があります
  • 不完全な例が含まれます
  • 概念的な疑似コードが含まれます
  • 本番用の認証情報が必要な例があります
  • テスト可能な内容とそうでない内容が混在しています
詳しくは Testable Snippets Guide を参照してください。