| name | .claude/skills/request-response-examples/SKILL.md |
| description | APIリクエスト・レスポンスの具体的なサンプル作成と
エラーケースドキュメント化のための知識とテンプレート
📚 リソース参照:
このスキルには以下のリソースが含まれています。
必要に応じて該当するリソースを参照してください:
- `.claude/skills/request-response-examples/resources/error-response-standards.md`: エラーレスポンス標準ガイド
- `.claude/skills/request-response-examples/resources/example-design-patterns.md`: リクエスト・レスポンス例 設計パターン
- `.claude/skills/request-response-examples/resources/sdk-examples.md`: 言語別SDKサンプル作成ガイド
- `.claude/skills/request-response-examples/scripts/generate-curl-examples.js`: OpenAPI 仕様から cURL コマンド例を生成するスクリプト
- `.claude/skills/request-response-examples/scripts/validate-examples.js`: OpenAPI 仕様内の example 検証スクリプト
- `.claude/skills/request-response-examples/templates/curl-examples.md`: cURLサンプルテンプレート
- `.claude/skills/request-response-examples/templates/error-catalog.md`: エラーカタログテンプレート
|
| version | 1.0.0 |
Request/Response Examples スキル
概要
API ドキュメントにおける具体的なリクエスト・レスポンス例、
エラーケース、エッジケースの効果的な文書化手法を提供します。
知識ドメイン
1. リクエスト例設計
- cURL コマンド形式
- 言語別 SDK サンプル（JavaScript, Python, Go, etc.）
- HTTP リクエスト生フォーマット
- 必須/オプションパラメータの明示
2. レスポンス例設計
- 成功レスポンス（200, 201, 204）
- ページネーション付きリスト
- ネストしたリソース表現
- HATEOAS リンク
3. エラーレスポンス
- RFC 7807 Problem Details 形式
- エラーコード体系
- バリデーションエラー詳細
- リトライ可能性の明示
4. エッジケース
- 空配列・null 値
- 大量データ
- 特殊文字・Unicode
- タイムゾーン・日付形式
5. インタラクティブ例
- Try It Out 機能
- サンドボックス環境
- テストデータ戦略
リソース
| ファイル |
内容 |
resources/example-design-patterns.md |
効果的なサンプル設計パターン |
resources/error-response-standards.md |
エラーレスポンス標準（RFC 7807） |
resources/sdk-examples.md |
言語別 SDK サンプル作成ガイド |
テンプレート
| ファイル |
用途 |
templates/curl-examples.md |
cURL コマンドテンプレート |
templates/error-catalog.md |
エラーカタログテンプレート |
使用方法
このスキルを使用して：
1. APIエンドポイントの具体的なリクエスト例を作成
2. 成功・エラーレスポンスの両方を文書化
3. 開発者が即座に使えるコードスニペットを提供
4. エッジケースとその処理方法を明示
適用対象
- REST API ドキュメント
- GraphQL API サンプル
- WebSocket メッセージ例
- SDK リファレンス
- チュートリアル・クイックスタート
関連スキル
| スキル |
パス |
関連性 |
| .claude/skills/openapi-specification/SKILL.md |
.claude/skills/openapi-specification/SKILL.md |
OpenAPI 仕様書内の examples 定義 |
| .claude/skills/authentication-docs/SKILL.md |
.claude/skills/authentication-docs/SKILL.md |
認証リクエスト/レスポンス例 |
| .claude/skills/api-documentation-best-practices/SKILL.md |
.claude/skills/api-documentation-best-practices/SKILL.md |
API ドキュメント全体のベストプラクティス |
変更履歴
| バージョン |
日付 |
変更内容 |
| 1.0.0 |
2025-11-27 |
初版リリース。リクエスト/レスポンス例設計パターン、RFC 7807 エラー標準、SDK 例を追加 |