Request Response Examples

request-response-examples

概要

API仕様に沿ったリクエスト/レスポンス例を、スコープ定義→例示作成→検証の順で整備するスキル。 利用者がそのまま実行できるサンプルと、失敗時のエラー例を同時に提供する。

ワークフロー

Phase 1: 例示スコープ定義

目的: 例示対象と必要なケースを決める

アクション:

1. API仕様、対象ユーザー、制約を整理する
2. references/example-scope.md で対象範囲とケースを決定する
3. references/error-response-standards.md でエラー形式を確認する
4. 例示スコープシートを作成する

Task: agents/define-example-scope.md を参照

Phase 2: 例示作成

目的: テンプレートに沿って実行可能な例を作る

アクション:

1. assets/request-response-template.md で例示を構成する
2. assets/curl-examples.md を使ってcURL例を整備する
3. assets/sdk-example-template.md でSDK例を整備する
4. assets/error-catalog.md でエラー例を整理する
5. 必要に応じて scripts/generate-curl-examples.mjs を使う

Task: agents/compose-examples.md を参照

Phase 3: 検証と統合

目的: 例示の正確性と一貫性を確認する

アクション:

1. scripts/validate-examples.mjs で必須項目を検証する
2. references/example-format-guidelines.md で整合を確認する
3. ドキュメントに統合し、必要な更新を記録する

Task: agents/validate-examples.md を参照

Task仕様ナビ

詳細仕様: 各Taskの詳細は agents/ ディレクトリを参照

ベストプラクティス

すべきこと

避けるべきこと

リソース参照

scripts/（決定論的処理）

references/（詳細知識）

assets/（テンプレート・素材）

変更履歴