エンドポイントとは、APIでリクエストを送る具体的な入口のことです。
多くの場合、URLとして表されます。
エンドポイントとは
APIは、別のプログラムから機能を呼び出すための窓口です。
その中で、どの機能にアクセスするかを示す具体的な場所がエンドポイントです。
たとえば、次のようなURLです。
https://example.com/api/users
https://example.com/api/posts
https://example.com/api/login
それぞれ、ユーザー一覧、投稿一覧、ログイン処理などの入口になります。
APIとの関係
API全体はサービスの窓口の集まりです。エンドポイントは、その中の一つひとつの入口です。
| 用語 | 例 |
|---|---|
| API | 学習記録サービスのAPI全体 |
| エンドポイント | /api/records や /api/login |
「どのURLに、どの方法で、何を送るか」がAPI利用では重要になります。
HTTPメソッドとの組み合わせ
エンドポイントは、HTTPメソッドと組み合わせて意味が決まります。
| メソッド | 役割の例 |
|---|---|
| GET | データを取得する |
| POST | データを作成する |
| PUT / PATCH | データを更新する |
| DELETE | データを削除する |
同じ /api/posts でも、GETなら投稿一覧の取得、POSTなら新しい投稿の作成というように役割が変わることがあります。
初心者向けの例
Todoアプリなら、次のようなエンドポイントが考えられます。
GET /api/todos
POST /api/todos
PATCH /api/todos/123
DELETE /api/todos/123
URLだけでなく、メソッドもセットで読むと理解しやすくなります。
よいエンドポイントの考え方
初心者は、エンドポイント名をわかりやすくすることを意識しましょう。
- 何のデータを扱うかがわかる
- 複数形をそろえる
- 動詞をURLに入れすぎない
- メソッドで操作を表す
最初から完璧でなくても、読み手が理解しやすい名前を目指すことが大切です。
まとめ
エンドポイントは、APIでリクエストを送る具体的な入口です。URLとHTTPメソッドをセットで見ると、どの機能を呼び出しているのか理解しやすくなります。
← 一覧に戻る