エンドポイント
別名: Endpoint, APIエンドポイント
エンドポイントは、APIの「窓口」となるURLです。
YouTubeで動画を再生したときを考える
YouTubeで動画をタップしたとします。すると動画のデータがサーバーから取得され、画面に表示されます。
この「動画データを取得する」という処理は、APIが担っています。
そしてそのAPIに「動画を取得してほしい」と呼び出すための連絡先が、エンドポイントです。
GET /videos/abc123
電話番号に例えると分かりやすいです。エンドポイントは「この番号に電話すれば、この仕事をしてもらえる」という番号のようなものです。番号(URL)と「何をしたいか」(HTTPメソッド)をセットで渡すと、APIが仕事をして結果を返してくれます。
同じURLでも、メソッドで役割が変わる
エンドポイントはURLだけでなく、HTTPメソッドとのセットで1つの窓口になります。
| メソッド | パス | 意味 |
|---|---|---|
| GET | /videos/:id | 動画を取得する |
| DELETE | /videos/:id | 動画を削除する |
URL(連絡先)は同じでも、「取得したい」か「削除したい」かで操作が変わります。
エンドポイントの設計例
REST APIでは、URLとメソッドの組み合わせで「何に対して何をするか」が一目で分かるように設計します。
| メソッド | パス | 操作 |
|---|---|---|
| GET | /videos | 動画の一覧を取得 |
| GET | /videos/:id | 特定の動画を取得 |
| POST | /videos | 動画を投稿 |
| DELETE | /videos/:id | 動画を削除 |
GET /videos を見れば「動画一覧を取得する窓口だな」と分かる、これがエンドポイント設計の基本です。
まとめ
- ✓エンドポイントはAPIの窓口となるURL
- ✓HTTPメソッドとURLの組み合わせで1つの機能を表す
- ✓同じURLでもメソッドが違えば操作が異なる