Skills DirectoryGitHub から厳選したオープンソースの Skills
日本語

api-and-interface-designcommit 63128d0SKILL.md · アーキテクチャ設計

API/インターフェース設計

契約優先、一貫したエラー、境界での検証、追加による拡張で、安定して誤用しにくい API とインターフェースを設計します。

npx skills add addyosmani/agent-skills --skill api-and-interface-design
権限
  • read-repo
  • write-files
  • shell
  • network
対応ツール
Claude Code, Codex, Cursor, Copilot, Gemini CLI
GitHub
112.3k
提供元
コミュニティ · Addy Osmani
状態
スキャン済み
ライセンス
MIT
カテゴリ
アーキテクチャ設計
リポジトリ
github.com/addyosmani/agent-skills/skills/api-and-interface-design

基本ルール

ハイラムの法則により観測できる挙動はすべて誰かに依存されるため、公開するものを意図的に選びます。

実行フェーズ

  1. フェーズ 01契約を先に定義

    実装前に型付きの入出力インターフェースを定義し、契約を仕様とします。

  2. フェーズ 02エラーと検証を統一

    全エンドポイントで同じエラー形式を使い、入力の検証はシステム境界だけで行い、外部 API の応答は常に信頼しません。

  3. フェーズ 03拡張前提で設計

    新しいフィールドは任意にし、型変更や削除はしません。単一バージョンの原則、一貫した命名、一覧エンドポイントのページングを守ります。

  4. フェーズ 04冪等キーを守る

    冪等キーは試行ではなく意図から作り、一意制約で原子的に確保し、同じキーで本文が違えば明示的に失敗させ、保持期間は最長の再試行経路に合わせます。

  5. フェーズ 05チェックリスト確認

    各エンドポイントに型付きの入出力があり、エラー形式が統一され、変更が後方互換で、型やドキュメントが実装と一緒にコミットされていることを確認します。

権限の説明（SKILL.md より）

機能必要か説明
ファイル書き込み必要インターフェースの型、スキーマ定義、API の処理コード、付随するドキュメントを書きます。
コマンド実行不要コマンドの実行は求めていません。
外部通信不要ネットワークにはアクセスしません。

SKILL.md のフロントマター（YAML）

SKILL.md のフロントマター（YAML）commit 63128d0
---
name: api-and-interface-design
description: Guides stable API and interface design. Use when designing APIs, module boundaries, or any public interface. Use when creating REST or GraphQL endpoints, defining type contracts between modules, or establishing boundaries between frontend and backend.
---

関連スキル

ルールスキャンですべてのリスクを検出できるわけではありません。インストール前にこのスキルの SKILL.md を読み、権限を確認してください。
Markdown 版 GitHub