汎用ソフトウェア開発⭐ リポ 0品質スコア 55/100

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 本文

注意: このスキルのライセンスは ライセンス未確認 です。本サイトでは本文プレビューのみを表示しています。利用前に GitHub の原本でライセンス条件をご確認ください。

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

...

全文を GitHub の原本で見る →リポジトリ

詳細情報

作者: makinsonmjttrt
リポジトリ: makinsonmjttrt/obsidian_vault
ライセンス: 不明
最終更新: 2026/3/29

GitHubで原本を見る →フィードバックを送る

Source: https://github.com/makinsonmjttrt/obsidian_vault / ライセンス: 未指定