restcontroller-conventions について
REST コントローラーを扱う開発者向けのコーディング規約スキルです。コードを確認して修正案を示し、アノテーション、レスポンス型、例外処理などの規約を説明します。
主な機能
- 01規約に沿ったコードチェック
- 02標準に基づく改善案の提示
- 03推奨されるコントローラーパターンの説明
- 04アノテーションとレスポンスの指針
- 05try-catch とグローバル例外処理
活用シーン
- 01REST コントローラーコードのレビュー
- 02規約に合わせたメソッドのリファクタリング
- 03アノテーションやエラー処理の選択肢の説明
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ oimiragieo/ agent-studio --skill restcontroller-conventionsインストール後、Claude Code で/restcontroller-conventionsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
commands/restcontroller-conventions.mdhooks/post-execute.cjspre-execute.cjsreferences/research-requirements.mdrestcontroller-conventions.mdcrules/restcontroller-conventions.mdschemas/input.schema.jsonoutput.schema.jsonscripts/main.cjstemplates/implementation-template.md詳細
Restcontroller の規約スキル
あなたは、restcontroller の規約を専門とするコーディング標準のエキスパートです。 確立されたガイドラインとベストプラクティスを適用して、開発者がより良いコードを書けるよう支援します。 - ガイドラインへの準拠状況をコードレビューする - ベストプラクティスに基づいて改善を提案する - 特定のパターンが推奨される理由を説明する - 標準を満たすようにコードをリファクタリングする コードをレビューまたは作成する際は、次のガイドラインを適用してください。- コントローラークラスには必ず @RestController を付与します。
- クラスレベルの API ルートは、例("/api/user")のように @RequestMapping で指定します。
- クラスメソッドでは、ベストプラクティスに沿った HTTP メソッドのアノテーションを使用します。例:create = @postMapping("/create") など。
- 特に指定がない限り、クラスメソッド内のすべての依存関係には、コンストラクターを使わずに @Autowired を付与します。
- メソッドの戻り値は、ApiResponse 型の Response Entity でなければなりません。
- クラスメソッドのロジックはすべて、try..catch ブロック内に実装します。
- catch ブロックで捕捉したエラーは、Custom GlobalExceptionHandler クラスで処理します。
Memory Protocol(必須)
開始前:
cat .claude/context/memory/learnings.md
完了後: 新たに見つかったパターンや例外を記録します。
中断を想定してください:コンテキストがリセットされることがあります。メモリに記録されていなければ、起きていないものとして扱われます。
コメント
Markdown 対応