投稿

[Python 100日チャレンジ] Day 55 - API設計の基本

REST APIのURL設計、HTTPメソッド、ステータスコード、JSONレスポンスの基本を学びます。

[Python 100日チャレンジ] Day 55 - API設計の基本

API設計とは

API設計では、利用者が分かりやすく使える入口を作ります。URL、HTTPメソッド、レスポンス形式をそろえることが大切です。

URLの例

1
2
3
4
5
GET    /users
GET    /users/1
POST   /users
PATCH  /users/1
DELETE /users/1

ステータスコード

  • 200: 成功
  • 201: 作成成功
  • 400: リクエスト不正
  • 404: 見つからない
  • 500: サーバーエラー

今日のゴール

APIは「使う人にとって予測しやすい」ことが大切です。URL、メソッド、ステータスコードをセットで考えましょう。

この投稿は投稿者によって CC BY 4.0 の下でライセンスされています。