7gram

ARTICLES / API DESIGN

API設計の
10講

「動く」の、その先を設計する。

再送、大量アクセス、仕様変更、障害。
Web APIを支える基礎を、仕組みと具体例から学ぶ10の解説です。

第1講から読む

01 — 10 / CONTENTS

10の視点から、APIを読む

  1. 01

    冪等性

    同じ要求を繰り返しても、意図した効果が増えないこと。

    Idempotency
  2. 02

    ページネーション

    何件目から取るか、どの値の続きから取るか。

    Pagination
  3. 03

    バージョン管理

    変更しても既存クライアントを壊さないための契約。

    Versioning
  4. 04

    レート制限

    継続的な利用量と、一時的な集中を制御する。

    Rate limiting
  5. 05

    エラー契約

    クライアントが、失敗後に何をすべきか判断できること。

    Error contracts
  6. 06

    キャッシュ

    再利用できる期間と、変更確認の方法を分ける。

    Caching
  7. 07

    JWTとセキュリティ

    JWTの署名、有効期限、情報量を別々に考える。

    JWT & security
  8. 08

    N+1クエリ

    一覧の件数に比例して、DBへの往復が増える問題。

    N+1 queries
  9. 09

    ドキュメント

    APIの契約を、人とツールが読める形にする。

    Documentation
  10. 10

    整合性

    どの場面で、どの程度の古さを許せるか。

    Consistency

掲載している件数や時間は仕組みを理解するための例であり、推奨設定値ではありません。出典は各章に掲載しています。