「エンドポイントが間違っている」
「そのエンドポイントへリクエストを送って」
Web APIを使う時に登場するのが「エンドポイント」です。
今回は、エンドポイントを「役所の受付窓口」に例えて解説します。
結論:「エンドポイント」=「Web APIへ要求を送る具体的な場所」
Web APIにおけるエンドポイントは、「どの機能へリクエストを送るかを示す具体的な宛先」です。
多くの場合はURLで表されます。ただし、同じURLでもGET、POST、DELETEなどのHTTPメソッドによって操作が変わるため、URLだけで機能が決まるとは限りません。
「役所の窓口」で例えると?
役所には、住民票、税金、転居届など、目的ごとの窓口があります。
Web APIにも同じように、扱う情報ごとの宛先があります。
GET https://api.example.com/users
ユーザー一覧を取得する窓口です。
GET https://api.example.com/users/123
IDが123のユーザーを取得する窓口です。
POST https://api.example.com/users
同じ/usersでも、POSTなら新しいユーザーを作成する操作として設計できます。
ここで使っているexample.comは説明用の予約ドメインで、実在サービスのAPIではありません。
エンドポイントを作る要素
ベースURL
API全体の基本となる住所です。
https://api.example.com
パス
対象となる資源や機能を表します。
/users/123
HTTPメソッド
取得、追加、更新、削除など、何をしたいかを示します。
- GET: 取得
- POST: 作成や処理の依頼
- PUT/PATCH: 更新
- DELETE: 削除
実際の意味はAPIの設計によって決まるため、必ずドキュメントを確認します。
クエリパラメータ
検索条件や並び順などを追加します。
GET https://api.example.com/users?role=admin
「エンドポイントを叩く」とは?
開発現場で使われる「叩く」は、エンドポイントへリクエストを送るという意味のくだけた表現です。
正式な説明では、「呼び出す」「リクエストを送る」と言えば十分です。言葉の由来を無理に覚えるより、具体的に何を送って何を受け取るのかを確認しましょう。
正しい窓口でも失敗することがある
エンドポイントが合っていても、次の理由で失敗します。
- 認証情報がない、または期限切れ
- 必須項目が足りない
- HTTPメソッドが違う
- 利用回数の上限を超えた
- サーバー側で問題が起きた
その結果は、HTTPステータスコードやレスポンス本文で伝えられます。
まとめ
- エンドポイント = 「Web APIへ要求を送る具体的な場所」
- 機能を決める要素 = 「URL、パス、HTTPメソッド、条件など」
- 叩く = 「エンドポイントへリクエストを送る」という現場表現
「どのURLか」だけでなく、「どの方法で、何を送るか」までがWeb API利用の大切な部分です。
次の記事では、APIでよく使われるデータ形式「JSON」について解説します。
ここまでお読みいただきありがとうございました!
QUICK CHECK
よくある質問
URLが同じなら同じエンドポイントですか?
APIの説明では、URLだけでなくHTTPメソッドも含めて区別することがあります。同じURLでもGETは取得、POSTは作成というように役割が異なる場合があります。
次に読むなら?
JSONの記事へ進むと、開発や通信の流れを順番に理解できます。
参考資料
用語の定義や仕様を確認するため、公式文書・標準文書を参照しています。リンク先の内容は更新される場合があります。