用 PHP 做一個最基本的 API

實際做之後才發現沒那麼複雜。

簡述

如果想要回傳一個 JSON 格式的資料，在 PHP 只要做兩件事就好：

1. 用 array 建立好 JSON 格式的物件
2. 用 PHP 的內建方法 json_encode 編碼成 JSON 資料

就是這麼簡單，附個範例：

// 最好是加上這個 header，不然會被當成 HTML 或純文字（text/html）
header('Content-type: application/json; charset=utf-8');
  $users = array();
  // 隨便產生的資料
  for ($i=0; $i<5; $i++) {
    array_push($users, array(
      "id" => $i,
      "name" => "PeaNu",
      "age" => '1' . $i,
      "created_at" => date('Y-m-d-H-i-s')
    ));
  }
  // 在包裝成一個物件
  $json = array("users" => $users);
  // JSON 編碼
  $response =  json_encode($json); 
  // 回傳 JSON 資料 
  echo $response;

結果長這樣：

延伸範例

如果你還記得留言版的話，會發現資料庫撈出來的資料只要先轉成 JSON，就可以當作是一支 API 了。

取得所有留言的 API：

<?php
  // 連線資料庫
  require_once('./conn.php');
  // 分頁功能
  $limit = 10;
  $offset = 0;
  // 分頁參數
  if (!empty($_GET['limit'])) {
    $limit = intval($_GET['limit']);
  }
  if (!empty($_GET['offset'])) {
    $offset = intval($_GET['offset']);
  }
  // SQL 指令
  $sql = 
    "SELECT users.username, users.nickname, comments.content, comments.created_at, comments.id, comments.is_deleted
    FROM comments LEFT JOIN users ON comments.username=users.username
    WHERE comments.is_deleted IS null
    ORDER BY comments.id DESC LIMIT ? OFFSET ?";
  $stmt = $conn->prepare($sql);
  $stmt->bind_param('ii', $limit, $offset);
  $result = $stmt->execute();

  if (!$result) {
    die('執行失敗，' . $conn->error);
  }
  $result = $stmt->get_result();

  // 產生留言資料（陣列包物件）
  $comments = array();
  while ($row = $result->fetch_assoc()) {
    array_push($comments, array(
        "id" => $row['id'],
        "username" => $row['username'],
        "nickname" => $row['nickname'],
        "content" => $row['content'],
        "created_at" => $row['created_at']
      )
    );
  }
  // 最外層在包成物件
  $json = array(
    "comments" => $comments
  );
  // JSON 編碼
  $response = json_encode($json);
  // 設定資料格式
  header('Content-type: application/json;charset=utf-8');
  // 回傳
  echo $response;
?>

結果長這樣：

其實也沒有很複雜，就只是把網頁的「純資料」抽出來而已。