Skip to content
cccskills
FreePublished on GitHub

API Design Consistency

Ensure API design follows RESTful naming and consistent conventions.

The English summary is being prepared. Showing the original description.

See how to install

Files included (3)

  • SKILL.md2.8 KB
  • fixtures/01-verb-path-inconsistent-errors-should-detect.md2.0 KB
  • fixtures/02-generated-spec-refresh-should-not-detect.md1.6 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Pattern declaration

Primary pattern: Reviewer Secondary patterns: Inversion Why: APIエンドポイントの命名・エラー応答・認可の一貫性をRESTful基準で検証する。

Rule / ルール

  • エンドポイントはリソース指向の RESTful 命名に従う(動詞を避ける)
  • ステータスコードとエラーレスポンスを一貫させる
  • バージョニングや認可要件を明示する

Heuristics

  • /getUser, /doAction のような動詞ベースのパス
  • 4xx/5xx のステータスやエラー構造がエンドポイントごとに不揃い
  • 認可・バージョンの記載が ADR/設計と乖離

Good / Bad Examples

  • Good: /users/{id}, /projects/{id}/members
  • Bad: /fetchUser, /doLoginNow
  • Good: エラーボディに code/message/detail を含めて統一

Actions / 改善案

  • パスをリソース指向にリネームし、コレクション/単体の区別を明確にする
  • エラー応答を共通スキーマに合わせる
  • ADR/設計で定義した認可・バージョン要件をエンドポイント仕様に反映する

Non-goals / 扱わないこと

  • API ゲートウェイやルーティング基盤の再設計。
  • 既存クライアントの破壊的変更に関する移行計画。
  • 実装レベルのパフォーマンス最適化。

Pre-execution Gate / 実行前ゲート

このスキルは以下の条件がすべて満たされない限りNO_REVIEWを返す。

  • 差分にAPI定義またはルーティング関連ファイル(**/api/**, **/routes/**)が含まれている
  • 差分にエンドポイントの追加・変更・削除が含まれている
  • inputContextにdiffが含まれている

ゲート不成立時の出力: NO_REVIEW: api-design — API定義/ルーティングの変更なし

False-positive guards / 抑制条件

  • 既存の API ガイドラインに完全準拠している差分。
  • 自動生成された API 定義の更新のみで、設計意図に変化がない。

評価指標(Evaluation)

  • 合格基準: 指摘が差分に紐づき、根拠と次アクションが説明されている。
  • 不合格基準: 差分と無関係な指摘、根拠のない断定、抑制条件の無視。

人間に返す条件(Human Handoff)

  • 仕様や意図が不明確で解釈が分かれる場合は質問として返す。
  • 影響範囲が広い設計判断やトレードオフは人間レビューへ返す。

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

<What this skill does>

The English summary is being prepared. Showing the original description.

s977043/river-review7Updated Oct 21, 2026

画像・ボタン・フォーム要素に適切なアクセシブルネームがあるか確認する。

The English summary is being prepared. Showing the original description.

s977043/river-review7Updated Oct 21, 2026

Ensure ADRs capture context, decision, alternatives, tradeoffs, and follow-ups in a way that prevents future drift.

The English summary is being prepared. Showing the original description.

s977043/river-review7Updated Oct 21, 2026

敵対的分析手法を統合したレビューの entry skill。認知バイアス対策の3手法 (Pre-mortem / War Game / Logic Torturing)と、宣言・主張と実態の乖離を突く claim-vs-actual 検出3パターン(Self-Contradiction / Refactor-Claim Audit / Cross-File Leakage)へルーティングし、通常のレビューでは見えない設計の盲点・ 防御の穴・論理の弱点・宣言と実装のズレを可視化する。

The English summary is being prepared. Showing the original description.

s977043/river-review7Updated Oct 21, 2026

Review changes to the Agent Skills import/export bridge for path safety, round-trip fidelity, and validation correctness.

The English summary is being prepared. Showing the original description.

s977043/river-review7Updated Oct 21, 2026

Checks whether AI-assisted work defines review criteria, accessible context, explicit review loop, human judgment boundary, and feedback capture before delegating to an agent.

The English summary is being prepared. Showing the original description.

s977043/river-review7Updated Oct 21, 2026

See all skills by s977043

Report a problem with this skill