はじめに
「API Base URLって、エンドポイントURLとは何が違うの？」
「APIの設定画面にURLがいくつも表示されていて、どこまでをBase URLとして入力すればいいの？」と迷っていませんか。
APIを初めて設定すると、https://example.com/apiのようなURLと、https://example.com/api/usersのようなURLが並んでいて、どちらを使えばよいのか判断しにくいことがあります。
この記事では、API Base URLの意味からエンドポイントとの違い、URLのどこを見ればBase URLと判断できるのかまで、実際のURLを確認しながら順を追って説明していきます。
API Base URLとは？
API Base URLは、複数のAPIエンドポイントで共通して使うURLの土台を指します。
ここでは、API Base URLの役割とAPIエンドポイントとの違いを順番に説明します。
API Base URLは共通して使うURLの土台
API Base URLは、複数のAPIで共通して使うURLの部分です。
たとえば「https://api.example.com/v1」をBase URLとすると、ユーザー取得やデータ登録などの機能ごとにパスを追加してURLを組み立てます。
APIのURLを作るときの土台になる部分と考えると分かりやすいでしょう。
APIエンドポイントとの違いは「呼び出す機能へのパス」
APIエンドポイントは、APIで利用する具体的な機能を示すURLです。
たとえば「https://api.example.com/v1/users」なら、「https://api.example.com/v1」がBase URL、「/users」がユーザー情報を扱うパスにあたります。
Base URLは共通でも、利用する機能によって「/users」や「/products」など、その先のパスが変わります。
APIのURLだけでなく、APIそのものの仕組みや役割から整理したい方は、基本的な使われ方もあわせて確認してみましょう。
▶APIとは？仕組みや使い方をわかりやすく解説
API Base URLの構造を具体例で確認する
API Base URLを見分けるには、URL全体をドメイン・パス・バージョンなどに分けて確認すると分かりやすくなります。
ここでは、具体的なURLをもとにBase URLの見分け方とエンドポイントとの組み合わせ方を説明します。
ドメインとパスからBase URLを見分ける
Base URLを見分けるときは、URLのドメインと、その後に続く共通のパスを確認します。
たとえば「https://api.example.com/v1/users」で「https://api.example.com/v1」までが複数のAPIに共通していれば、そこがBase URLです。
「/users」のように機能ごとに変わる部分と分けて考えると判断しやすくなります。
バージョンを含むURLでBase URLを見分ける
APIによっては、「/v1」や「/v2」などのバージョン番号までBase URLに含める場合があります。
たとえば「https://api.example.com/v2/users」で「https://api.example.com/v2」までが共通なら、そこがBase URLです。
どこまで含めるかはAPIによって異なるため、迷ったときは公式ドキュメントを確認しましょう。
エンドポイントを組み合わせるとAPIのURLになる
APIを呼び出すURLは、Base URLに機能ごとのエンドポイントを組み合わせて作ります。
たとえばBase URLが「https://api.example.com/v1」、エンドポイントが「/users」なら、実際のURLは「https://api.example.com/v1/users」です。
「/products」に変えれば商品情報を扱うURLになるため、仕組みをシンプルに整理できます。
API Base URLを確認するときの見方
API Base URLが分からないときは、まずAPIドキュメントに記載された接続先を確認し、環境ごとにURLが分かれていないかを見ます。
ここでは、APIドキュメントや実際のURLからBase URLを見分ける方法を順番に説明します。
APIドキュメントでBase URLを確認する
APIドキュメントでは、「Base URL」「Base endpoint」「Server URL」などの項目から共通の接続先を確認できます。
たとえば「https://api.example.com/v1」と記載されていれば、そこに「/users」や「/orders」などのパスを追加して利用します。
複数のURLがある場合は、それぞれの用途もあわせて確認しましょう。
Base URLを確認したあと、実際にAPIへ接続する方法が分からない場合は、リクエストの送り方も確認しておくと進めやすくなります。
▶APIの使い方とは？リクエストを送る基本手順を解説
開発環境と本番環境でBase URLが変わる場合
APIによっては、開発環境と本番環境で異なるBase URLが用意されています。
たとえば開発環境では「https://dev-api.example.com/v1」、本番環境では「https://api.example.com/v1」のように接続先が分かれます。
誤った環境へ接続しないよう、ドキュメントで用途を確認してから対応するURLを選びましょう。
実際のAPI URLからBase URLを切り分ける
実際のAPI URLから確認するときは、複数のURLを並べて共通する部分を探します。
「https://api.example.com/v1/users」と「https://api.example.com/v1/orders」なら、「https://api.example.com/v1」が共通部分です。
ただし、Base URLの範囲はAPIによって異なるため、最後にドキュメントの記載と照らし合わせておくと安心です。
API Base URLで間違えやすいポイント
API Base URLを設定するときは、エンドポイントまで含めて指定したり、Base URLとエンドポイントのパスを重複させたりすると、正しいAPI URLを作れなくなることがあります。
ここでは、API Base URLを設定・利用するときに間違えやすいポイントを順番に説明します。
エンドポイント全体をBase URLにしない
Base URLには、「/users」など特定の機能を示すパスまで含めないようにします。
たとえば「https://api.example.com/v1/users」なら、「https://api.example.com/v1」をBase URL、「/users」をエンドポイントとして分けます。
ほかの機能にも使える共通部分をBase URLにすると、URLを管理しやすくなります。
Base URLとエンドポイントのパスを重複させない
Base URLとエンドポイントに同じパスを指定すると、「/users/users」のように重複したURLになることがあります。
正しいURLが「https://api.example.com/v1/users」なら、Base URLを「https://api.example.com/v1」エンドポイントを「/users」と分けましょう。
設定後は、実際に組み立てられたURLを確認すると間違いを見つけやすくなります。
末尾のスラッシュやURLの指定方法を確認する
Base URLとエンドポイントを組み合わせるときは、「/」の位置にも注意が必要です。
指定方法によっては「/v1//users」のように重複したり、「/v1users」のようにつながったりすることがあります。
使用するツールやコードの結合方法を確認し、最終的なURLがAPIの仕様どおりになっているか確かめましょう。
まとめ
API Base URLは、複数のAPIで共通して使うURLの土台で、その先に「/users」などのエンドポイントを追加して目的の機能を呼び出します。
どこまでがBase URLか迷ったときは、URLだけで判断せず、まずAPIドキュメントの記載を確認すると安心です。
また、開発環境と本番環境の取り違えやパスの重複にも気をつけながら、最後に完成したURLを確認しておきましょう。
Base URLとエンドポイントの役割を分けて考えると、APIのURLも整理しやすくなります。
