api-design-review

API設計レビュー

REST、GraphQL、gRPC、非同期イベントAPIの設計や契約を、互換性・ページネーション・認可など7項目でレビューします。

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

このSkillでできること

  • ✓REST、GraphQL、gRPC、非同期イベントAPIの設計・契約をレビューする
  • ✓互換性、ページネーション、冪等性、エラー意味論を評価する
  • ✓バージョニング、認可モデル、レート制限を確認する
  • ✓Approvedなどの判定を含む単一のMarkdownレポートを作成する
02

使い方

01
STEP 1

レビュー対象のAPI仕様または契約をapi_specとして用意する

02
STEP 2

必要に応じてprevious_specを渡し、バージョン差分を確認する

03
STEP 3

必要に応じてsystem_design_contextを渡して関連設計と照合する

04
STEP 4

レビュー結果としてAPI_DESIGN_REVIEW_REPORT.md形式のレポートを作成する

03

Skillのインストール

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

Repository:
https://github.com/luckyrjain/software-builder
手動でインストールする

README / SKILL.mdから機械抽出できたコマンドのみ表示しています。推測したコマンドではありません。

git clone https://github.com/luckyrjain/software-builder.git
cd software-builder
bash scripts/install.sh --agent cursor loop-task-implementer
test -f ~/.cursor/skills/loop-task-implementer/SKILL.md
04

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

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

このAPI仕様をレビューしてください。互換性、ページネーション、冪等性、エラー意味論、バージョニング、認可、レート制限を確認し、判定と指摘事項をMarkdownレポートでまとめてください。
出力例を見る
# API Design Review Report

## Verdict
Approved with conditions

## Compatibility
...

## Pagination
...

## Idempotency
...

## Error semantics
...

## Versioning
...

## Authorization
...

## Rate limiting
...
05

安全性チェック

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

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

関連Skill