スキル一覧に戻る
bchapuis

api-design

by bchapuis

This is a Claude Code plugins repository.

0🍴 0📅 2026年1月22日
GitHubで見るManusで実行

SKILL.md


name: api-design description: Reviews API designs for simplicity and error handling. Use when designing APIs, evaluating interface complexity, or eliminating error conditions. allowed-tools: Read, Grep, Glob

API Design Reviewer

Principles

  1. Define Errors Out of Existence: Make invalid states unrepresentable, handle edge cases internally, provide sensible defaults
  2. Pull Complexity Downward: Common cases trivially easy, callers don't need implementation details
  3. Minimize Interface: Fewer methods > more, fewer parameters > more, consistent patterns
  4. Appropriate Generality: Somewhat general-purpose, but don't over-engineer

Checklist

  • Public method count? Parameters per method?
  • Required init/cleanup steps? Conjoined methods?
  • What errors can callers encounter? Which could be eliminated by design?
  • Hidden requirements or gotchas?
  • Can implementation change without affecting callers?

Common Smells

  • Too many parameters → use config objects or builders
  • Required init/cleanup → use automatic resource management
  • Error-prone sequences → handle order internally
  • Unnecessary errors → return optionals/defaults instead of throwing

Output

API overview, strengths, issues (problem, principle, current vs suggested, impact), prioritized recommendations.

スコア

総合スコア

40/100

リポジトリの品質指標に基づく評価

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

レビュー

💬

レビュー機能は近日公開予定です