読み方 : エーピーアイエンドポイント

APIエンドポイント【API endpoint】

概要

APIエンドポイントとは、Web APIが外部からのリクエストを受け付ける接続先のURLクライアントサーバの特定の機能やデータにアクセスする際の要求の宛先を指す。
APIエンドポイントのイメージ画像

APIはシステム同士が機能を呼び出し合うための取り決めであり、エンドポイントはその取り決めの中で「どのURLに対してリクエストを送ればよいか」を示す具体的な所在地にあたる。Web APIの文脈では「https://~~」で始まるURLの形式で表現されるのが一般的である。

例えば、ユーザー情報を管理するサービスのREST APIであれば、「https://api.example.com/users」や「https://api.example.com/users/123」のようなURLがAPIエンドポイントとなる。前者はユーザー一覧の取得や新規作成、後者はID「123」の特定ユーザーへの操作に対応する。同じURLでもHTTPメソッド(GET、POST、PUT、DELETE)によって操作の内容が変わる。バージョン管理のために「/v1/users」のようにパスバージョン番号を含める設計が用いられることもある。

APIエンドポイントの設計にはいくつかの慣習がある。「REST原則」(RESTful API)では、リソースを表す名詞を使い、動詞は原則としてHTTPメソッドで表現する。階層関係は「/users/123/orders」のようにパスで表現し、検索条件や表示件数の指定にはURLの末尾に付加する「?page=2&limit=20」といった形式のクエリパラメータを使う。

APIドキュメントにはエンドポイントごとに受け付けるメソッドリクエストパラメータデータ本体の形式、レスポンスデータ構造、認証方式、エラーコードなどが記載される。SwaggerOpenAPI仕様に基づいてドキュメントを自動生成、公開するツールが広く使われており、利用者はWebブラウザ上でエンドポイントを確認しながら試験的なリクエストを送ることもできる。

この記事の著者 : (株)インセプト IT用語辞典 e-Words 編集部
1997年8月より「IT用語辞典 e-Words」を執筆・編集しています。累計公開記事数は1万ページ以上、累計サイト訪問者数は1億人以上です。学術論文や官公庁の資料などへも多数の記事が引用・参照されています。