APIについて、基本的なところを解説します！ これだけはマストで抑えてください。

APIの概要

APIとはApplication Programming Interfaceの略。 異なるシステム同士が通信するための手段。

リクエストとレスポンス

API通信は、クライアントからサーバーへのリクエストと、サーバーからクライアントへのレスポンスという２つで構成される。

リクエスト

クライアント → サーバーへ。 データの取得や処理などをお願いする。通信する際に、必要な値を渡すことができる。

レスポンス

サーバー → クライアントへ。 サーバーはクライアントからリクエストを受け取ったら、処理結果やエラーメッセージなどを返却する。

リクエストメソッド

リクエストメソッドは、クライアントがサーバーに対して、どのような操作を実行したいかを示すために使用される。 代表的なリクエストメソッドは以下の通り

• GET: サーバーからデータを取得
• POST: サーバーにデータを送信
• PUT: サーバー上のデータを更新
• DELETE: サーバー上のデータを削除

リクエストメソッドに沿った処理を行うAPIはRESTful API とも呼ばれる。 https://pwe-tech.com/post/openapi-swagger/

ヘッダー

ヘッダーは、リクエストやレスポンスに含まれる追加情報。 認証情報、データ形式、キャッシュ制御など、様々な情報がヘッダーに含まれる。

ステータスコード

ステータスコードは、サーバーからの応答状況を示す。

覚えておきたいステータスコード

200系

成功

200 OK

201 Created

300系

別ページに遷移した

301 Moved Permanently

302 Found

locationヘッダーで別ページに遷移したとき

400系

リクエストがおかしい

400 Bad Request

リクエストパラメータが不正

401 Unauthorized

認証情報が不正

403 Forbidden

アクセス権限なし（認可不足）

404 Not Found

ページが見つからない

500系

サーバーエラー

500 Internal Server Error

サーバー側がシステムエラー（バグ）

502 Bad Gateway

サーバーがダウンしてるかも？ネットワークに問題がありそう

504 Gateway Timeout

サーバーからの応答がない。ネットワークに問題がありそう