APIマッピングとは
APIマッピングとは、「このURLに来たリクエストは、この処理につなぐ」 という対応表(ルール)を作ることです。
Webやアプリでは、URL(入り口)と、実際に動く処理(中身)を分けて考えます。 その橋渡しをしているのがAPIマッピングです。
初心者向け:まずはイメージをつかもう
たとえ話で考える
APIマッピングは、受付カウンターのようなものです。
- 「ユーザー情報が欲しい」→ ユーザー担当へ
- 「注文データが欲しい」→ 注文担当へ
URLでいうと、こんな感じです。
/users → ユーザー情報を返す処理/orders → 注文情報を返す処理
どのURLが、どの処理につながるかを決める。 これがAPIマッピングの基本です。
現場でのAPIマッピング
なぜ必要なのか
- URLをわかりやすくしたい
- 中の仕組みを変えても、外のURLは変えたくない
- 開発用・本番用を分けたい
よくある構成
https://api.example.com/users↓
内部では Lambda や別サーバーの処理へ
現場では「URL設計」と「中身の処理」を分離することで、 変更に強いシステムを作っています。
APIマッピングは「画面」とも深く関係する
APIマッピングというと、 「URLとAPIを結びつける仕組み」と思われがちです。
しかし実際の開発現場では、 画面(UI)とAPIをどう対応付けるか という意味で使われることも多くあります。
初心者向け:画面とAPIの関係
Webアプリやスマホアプリでは、 画面は何もしない というのが基本です。
実際にデータを取得・保存・更新しているのはAPIです。
- ログイン画面 → ログインAPI
- ユーザー一覧画面 → ユーザー取得API
- 登録フォーム → 登録API
「この画面では、どのAPIを呼ぶのか」 これを整理することもAPIマッピングの一種です。
現場での考え方:画面=APIの入口
なぜ画面とAPIをマッピングするのか
- 画面の仕様変更に強くするため
- フロントエンドとバックエンドを分業しやすくするため
- APIの責務を明確にするため
よくある設計例
呼び出すAPI:
GET /api/users
呼び出すAPI:
GET /api/users/{id}保存API:
PUT /api/users/{id}
画面ごとに「使うAPI」を決めておくことで、 設計・実装・テストが一気に楽になります。
JavaScriptとの関係
画面とAPIのマッピングは、 多くの場合JavaScriptで実装されます。
fetch("/api/users")
.then(res => res.json())
.then(data => {
// 画面に表示
});
このコードは、 「ユーザー一覧画面 → ユーザー取得API」 というマッピングをそのまま表しています。
応用:APIマッピングを設計として考える
実務では、APIマッピングを 設計書レベルで整理することがあります。
- No
- 画面ID
- 画面名
- 使用するAPI
- HTTPメソッド
- 送信データ・受信データ
| No. | 画面ID | 画面名 | 操作 | HTTPメソッド | APIエンドポイント | 概要 |
|---|---|---|---|---|---|---|
| 1 | login_screen | ログイン画面 | ログイン | POST | /api/login | ユーザー認証を行う |
| 2 | user_list_screen | ユーザー一覧画面 | 一覧表示 | GET | /api/users | ユーザー一覧を取得 |
| 3 | user_detail_screen | ユーザー詳細画面 | 詳細表示 | GET | /api/users/{id} | 指定ユーザーの詳細情報を取得 |
| 4 | user_edit_screen | ユーザー編集画面 | 保存 | PUT | /api/users/{id} | ユーザー情報を更新 |
| 5 | user_register_screen | ユーザー登録画面 | 新規登録 | POST | /api/users | 新しいユーザーを登録 |
| 6 | user_delete_screen | ユーザー削除確認画面 | 削除 | DELETE | /api/users/{id} | ユーザーを削除 |
これにより、
- 画面はAPIの変更に影響されにくくなる
- APIはUIに依存しなくなる
- テストやモック作成が容易になる
APIマッピングとUIのまとめ
- APIマッピングはURLだけの話ではない
- 画面とAPIの対応付けも重要なAPIマッピング
- 「この画面はどのAPIを使うか」を整理する
- 現場では設計・分業・保守性に直結する
画面とAPIのマッピングを意識できるようになると、 「作れる人」から「設計できる人」へ一段レベルアップします。
応用:実務・クラウドでのAPIマッピング
AWS API Gateway の場合
API Gatewayでは、カスタムドメイン + パス を Lambda や REST API にマッピングします。
/v1/users → 本番用API/dev/users → 開発用API
マッピングテンプレートとの違い
- APIマッピング:どこにつなぐか
- マッピングテンプレート:データの形を変える
実務ではこの2つを組み合わせて、 柔軟で安全なAPI設計を行います。
まとめ
- APIマッピングは「URLと処理の対応表」
- 初心者はURLと処理の関係を理解するのが第一歩
- 現場では変更に強い設計のために必須
- 応用ではクラウドや認証とも組み合わせる
APIマッピングを理解すると、 Webサービス全体の構造が一気に見えてきます。