engram-server-api について
engram-server-api は、HTTP API のルートと契約を保守するための開発スキルです。成功・エラー両方のテストと、ハンドラーに沿ったドキュメント更新を重視します。
主な機能
- 01エンドポイント契約の規則
- 02ハンドラーレベルの検証テスト
- 03ルートのエンドツーエンドテスト
- 04契約不具合の回帰テスト
- 05ルート変更時のドキュメント更新
活用シーン
- 01HTTP ルートの追加・変更
- 02リクエスト／レスポンススキーマの更新
- 03ステータスコード動作の変更
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/engram-server-apiを入力して読み込まれたか確認します。
詳細
使用するタイミング
次の場合に、このスキルを使用します。
- HTTP ルートを追加または変更する場合
- ハンドラーのリクエスト／レスポンススキーマを更新する場合
- ステータスコードの動作を変更する場合
コントラクトのルール
- 追加または変更するエンドポイントには、必ずテストを用意してください。
- 成功時とエラー時の両方のパスをテストしてください。
- スクリプトとドキュメントを、実際のハンドラーに合わせてください。
- プラグインやフックで、存在しないエンドポイントを参照しないでください。
必須の検証
- パース／バリデーションエラーに対するハンドラーレベルのテスト
- ルートの動作とレスポンス本文に対する E2E テスト
- API コントラクトに関するバグ修正ごとの回帰テスト
ドキュメントのルール
ペイロードまたはルートを変更した場合は、同じ PR でドキュメントも更新してください。
コメント
Markdown 対応