APIを操作しながら、設計力を身につける

メソッド・ステータスコード・認可フロー・キャッシュ・信頼性を学ぶ

目指せる領域: HTTP API（設計・利用）API Playgroundで試す

HTTPの基礎

1-1

リクエストとレスポンスの構造

リクエストとレスポンスの構造を、1行目・ヘッダー・空行・本文の順に確認する。

1-2

HTTPメソッドの意味

GET・POST・PUT・PATCH・DELETEを、「安全か」「冪等か」で分類する。

1-3

ステータスコードの選び方

先頭の数字で分類を読み、2xxと4xxのコードを状況に合わせて選択する。

1-4

ヘッダーの役割

主要な4つのヘッダーの意味と、サーバーが応答形式を選ぶ仕組みを理解する。

1-5

URLの構造

URLの各部分の役割と、パスパラメーターとクエリパラメーターの使い分けを理解する。

RESTリソース設計

2-1

エンドポイントの名前の付け方

エンドポイントを、操作ではなく扱う対象の名詞で命名する。

2-2

CRUDとメソッドの対応

作成・取得・更新・削除を、どのメソッドとURLで表すか整理する。

2-3

絞り込み・並べ替え・項目の指定

クエリパラメーターで、リソース自体を変えずに結果を調整する。

2-4

ページネーション

オフセット方式とカーソル方式を比較し、オフセットで行が飛ぶ・重複する理由を確認する。

2-5

エラーレスポンスの設計

application/problem+json（RFC 9457）で、機械が読めるエラーを設計する。

認証と認可

3-1

認証と認可の違い

認証と認可を区別し、それぞれを誰が判断するか整理する。

3-2

APIキー

APIキーの発行と検証の流れと、URLやリポジトリに置いてはいけない理由を確認する。

3-3

セッションとトークンの違い

状態をサーバーに置くセッションと、認証情報に持たせるトークンを比較する。

3-4

JWTの構造と検証

header.payload.signatureの構造と、検証で確かめていることを確認する。

3-5

OAuth 2.0 認可コードフロー

認可コードフローに登場する4者と、それぞれが次に渡すものを整理する。

3-6

スコープと最小権限

トークンでできることを絞り、必要以上に権限を与えるリスクを確認する。

キャッシュと条件付きリクエスト

4-1

キャッシュを再利用してよいか

Cache-Controlの指示と、再利用前に行う「新鮮か、古いか」の判定を確認する。

4-2

ETagで更新の有無を確かめる

ETagで更新の有無を確認し、変わっていなければ304で本文を省略する。

4-3

Last-Modifiedで更新の有無を確かめる

ETagの識別子ではなく、更新時刻を使って更新の有無を確認する。

4-4

楽観ロックで、他人の変更を上書きしない

If-Matchと412で、書き込みが他人の変更を消すのを防止する。

信頼性のあるやり取り

5-1

冪等性キーで、二重送信を防ぐ

クライアントが作るキーをサーバーが記憶し、POSTを再送しても1回だけ実行する。

5-2

失敗したリクエストの再試行

間隔を広げながら再試行する方法と、再試行してよいメソッドを理解する。

5-3

レート制限

429とRetry-After、トークンバケットの考え方を理解する。

5-4

Webhook

サーバーからクライアントへ通知する仕組みと、送信元が本物か確認する方法を理解する。

5-5

更新をすぐ受け取る3つの方法

接続の持ち方とデータの向きで、ロングポーリング・SSE・WebSocketを比較する。

APIスタイルの比較

6-1

RESTのまとめ

リソース指向・HTTPの意味の活用・ステートレスという、RESTの3つの約束を整理する。

6-2

GraphQL

1つのエンドポイントで項目を指定する仕組みと、オーバーフェッチ・N+1との関係を理解する。

6-3

gRPC

バイナリ・スキーマ駆動・ストリーミングの特徴と、向いている場面を整理する。

6-4

OpenAPIでAPIの仕様を定義する

契約ファーストの開発と、スキーマから自動生成できるものを理解する。

6-5

バージョニング

URL方式・ヘッダー方式と、新バージョンが要らない変更の設計を整理する。

学習を続ける

前提コースLearn DB28レッスン

APIを操作しながら、 設計力を身につける