api-design
本番環境のAPIに必要なREST API設計パターンについて学べます。リソースの命名規則、ステータスコード、ページネーション、フィルタリング、エラーレスポンス、バージョニング、レート制限といった実装上の重要な要素をカバーしています。
description の原文を見る
REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.
SKILL.md 本文
APIデザインパターン
一貫性があり開発者にとって使いやすいREST APIを設計するための規約とベストプラクティス。
適用タイミング
- 新しいAPIエンドポイントを設計する場合
- 既存のAPIコントラクトをレビューする場合
- ページネーション、フィルタリング、またはソート機能を追加する場合
- API用のエラーハンドリングを実装する場合
- APIのバージョニング戦略を計画する場合
- 公開または認定パートナー向けのAPIを構築する場合
リソース設計
URLの構造
# リソースは名詞で、複数形、小文字、ケバブケース
GET /api/v1/users
GET /api/v1/users/:id
POST /api/v1/users
PUT /api/v1/users/:id
PATCH /api/v1/users/:id
DELETE /api/v1/users/:id
# 関連性を表すサブリソース
GET /api/v1/users/:id/orders
POST /api/v1/users/:id/orders
# CRUDにマッピングできないアクション(動詞は控えめに使用)
POST /api/v1/orders/:id/cancel
POST /api/v1/auth/logi
...
詳細情報
- 作者
- makinsonmjttrt
- ライセンス
- unknown
- 最終更新
- 2026/3/29
Source: https://github.com/makinsonmjttrt/obsidian_vault / ライセンス: unknown
関連スキル
doubt-driven-development
重要な判断はすべて、本番環境への展開前に新しい視点から対抗的レビューを実施します。速度より正確性が重要な場合、不慣れなコードを扱う場合、本番環境・セキュリティに関わるロジック・取り消し不可の操作など影響度が高い場合、または後でバグを修正するよりも今検証する方が効率的な場合に活用してください。
apprun-skills
TypeScriptを使用したAppRunアプリケーションのMVU設計に関する総合的なガイダンスが得られます。コンポーネントパターン、イベントハンドリング、状態管理(非同期ジェネレータを含む)、パラメータと保護機能を備えたルーティング・ナビゲーション、vistestを使用したテストに対応しています。AppRunコンポーネントの設計・レビュー、ルートの配線、状態フローの管理、AppRunテストの作成時に活用してください。
desloppify
コードベースのヘルスチェックと技術負債の追跡ツールです。コード品質、技術負債、デッドコード、大規模ファイル、ゴッドクラス、重複関数、コードスメル、命名規則の問題、インポートサイクル、結合度の問題についてユーザーが質問した場合に使用してください。また、ヘルススコアの確認、次の改善項目の提案、クリーンアップ計画の作成をリクエストされた際にも対応します。29言語に対応しています。
debugging-and-error-recovery
テストが失敗したり、ビルドが壊れたり、動作が期待と異なったり、予期しないエラーが発生したりした場合に、体系的な根本原因デバッグをガイドします。推測ではなく、根本原因を見つけて修正するための体系的なアプローチが必要な場合に使用してください。
test-driven-development
テスト駆動開発により実装を進めます。ロジックの実装、バグの修正、動作の変更など、あらゆる場面で活用できます。コードが正常に動作することを証明する必要がある場合、バグ報告を受けた場合、既存機能を修正する予定がある場合に使用してください。
incremental-implementation
変更を段階的に実施します。複数のファイルに影響する機能や変更を実装する場合に使用してください。大量のコードを一度に書こうとしている場合や、タスクが一度では完結できないほど大きい場合に活用します。