api-design-review

API設計レビュー

高リスクなAPI契約の設計判断をレビューする、呼び出し型の補助スキルです。

AIスキル大辞典による日本語要約
品質評価95/100評価確度:標準
人気度(GitHub Star) 24発掘スコア 100
01

このSkillでできること

  • ✓新規または変更されるAPIの契約範囲を整理する
  • ✓REST、RPC、GraphQL、WebHooks、WebSocketsなどの適合性を検討する
  • ✓入力・出力・エラー・認証・互換性の設計論点をレビューする
  • ✓変更が追加的か破壊的かを確認し、実装前に固定すべき契約詳細を整理する
02

使い方

01
STEP 1

/researchまたは/write-a-prdから、API形状に未解決の論点がある場合に呼び出す

02
STEP 2

新規APIか既存API変更か、利用者、通信形式、認証、互換性制約を整理する

03
STEP 3

問題、影響、開発者利用者、必要な操作一覧を確認する

04
STEP 4

パラダイム、契約形状、エラー設計、セキュリティ、互換性の観点でレビューする

03

Skillのインストール

このGitHubリポジトリにあるSkillを確認し、現在の環境に適した方法でインストールしてください。
インストール後、正常に利用できることを確認し、基本的な使い方も簡潔に説明してください。

Repository:
https://github.com/chrislacey89/skills
04

このSkillを使うプロンプト例

Skill名を明示すると、意図したSkillを使わせやすくなります。自動発動型では必須とは限りません。

外部利用者向けAPIの契約変更をレビューしてください。利用者、操作一覧、認証方式、互換性制約を整理し、適切なAPIパラダイム、入出力、エラー、セキュリティ、破壊的変更の有無を確認してください。
出力例を見る
APIの対象範囲、利用者と操作一覧、採用候補のパラダイム、契約上の不足点、認証・エラー設計、互換性リスク、実装前に確定すべき事項をまとめます。
05

安全性チェック

自動解析による参考情報です。Skillの安全性を保証するものではありません。

外部API通信明確な記述なし
Shellコマンド実行明確な記述なし
ファイル読み取り明確な記述なし
ファイル書き込み明確な記述なし
ネットワークアクセス明確な記述なし
認証情報明確な記述なし
06

関連Skill