REST API

目次

REST API とは?

REST API とは?
REST APIは、アプリとサーバーが会話するためのルールです!
比喩で言うと: レストランのメニュー

レストラン(サーバー)
├─ メニュー(API)
│  ├─ 料理を注文する (POST)
│  ├─ 料理を見る (GET)
│  ├─ 注文を変更する (PUT)
│  └─ 注文をキャンセルする (DELETE)
└─ 料理(データ)

ウェイター(API)が、あなた(アプリ)とキッチン(サーバー)の間を取り持つ!

REST って何の略?

REST = REpresentational State Transfer
日本語: データのやり取りの仕組み
要はURLでデータを操作する仕組み!

REST API の3つの基本要素

1)リソース(Resource) = 操作する「もの」

例:

投稿(Posts)
ユーザー(Users)
コメント(Comments)
商品(Products)

2) エンドポイント(Endpoint) = データの「住所」

エンドポイントは、リソースにアクセスするためのURL!

https://your-site.com/wp-json/wp/v2/posts
                      ↑              ↑
                    API のパス    リソース

比喩:

レストランの住所: 東京都〇〇区△△1-2-3
エンドポイント: https://your-site.com/wp-json/wp/v2/posts

「この住所に行けば、投稿データがある!」

3) HTTP メソッド(Method) = 何を「する」か

HTTPメソッドは、リソースに対して何をするかを指定!

メソッド意味料理の例
GET見る・読むメニューを見る
POST作る料理を注文する
PUT更新注文を変更する
DELETE削除注文をキャンセル

REST API の実例

ブログの投稿を操作する:

1. 投稿一覧を見る
   GET https://your-site.com/wp-json/wp/v2/posts
   
2. 投稿を1つ見る
   GET https://your-site.com/wp-json/wp/v2/posts/123
   
3. 新しい投稿を作る
   POST https://your-site.com/wp-json/wp/v2/posts
   
4. 投稿を更新する
   PUT https://your-site.com/wp-json/wp/v2/posts/123
   
5. 投稿を削除する
   DELETE https://your-site.com/wp-json/wp/v2/posts/123

パターン:

複数: /posts (一覧)
単体: /posts/123 (ID指定)

🌐 REST API の動きを図で理解

アプリ                              サーバー
│ │
│ GET /wp-json/news/v2/posts │
│ ─────────────────────────────→ │
│ │ データベースから
│ │ 投稿を取得
│ │
│ ← JSON データが返ってくる │
│ ←───────────────────────────── │
│ │
│ [ │
│ { │
│ "id": 1, │
│ "title": "お知らせ", │
│ "content": "..." │
│ } │
│ ] │

まとめ

APIが、アプリとサーバーの間を取り持つ!
アプリがエンドポイントにリクエスト
サーバーがデータを取得
JSON形式で返す
アプリが表示

目次