API 開發者經常面臨數據庫模式變更的挑戰。如果沒有良好的實現方案,修改列名就可能需要重構整個模型。本文將演示如何使用 Fractal 作為模型和 JSON 輸出之間的橋樑,簡化 API 開發流程。
關鍵要點:
Fractal 包
Fractal 是一個用 PHP 編寫的項目,屬於 The League of Extraordinary Packages。這些包都符合多項要求,例如使用 PHP-FIG 和單元測試覆蓋率。 Fractal 主要由 Phil Sturgeon 開發,並持續獲得定期改進。它也可以與 Composer 一起使用。
設置環境
為了演示,我將使用 Silex 和 Illuminate/Database(Laravel 的 ORM 組件)設置一個框架。即使您不熟悉其中任何一個,也沒關係。我將執行的操作非常簡單明了,我會盡可能地解釋清楚。如有任何不清楚的地方,請隨時留言。我將開始設置框架。請注意,如果您不想按照步驟操作,可以在文章末尾下載所有代碼。現在,在根文件夾內創建一個新文件夾。我們將從創建 composer.json 文件開始,其中包含我們需要的所有依賴項。在本例中:Silex 和 IlluminateDatabase。創建一個類似這樣的 composer.json 文件:
{ "require": { "silex/silex": "~1.2", "illuminate/database": "*" } }
使用 composer install
安裝這些包。
我將以一個在線音樂數據庫為例。該數據庫將提供多首歌曲的信息:歌曲名稱、藝術家姓名、藝術家網站、專輯名稱、發行日期和唱片公司。一開始,所有這些信息都將存儲在一個表中。如果您想自己嘗試,請從本文的代碼庫下載文件 1.sql,並在您的數據庫中運行它。
為了將 Silex 與 IlluminateDatabase 一起使用,我們需要一些代碼。在 app 文件夾內創建一個名為 index.php 的新文件。在這裡,我們將啟動 Silex,連接到數據庫並定義路由:
{ "require": { "silex/silex": "~1.2", "illuminate/database": "*" } }
第一行是引入 Composer 的自動加載文件。然後,我們創建一個新的 Silex 應用程序並加載 Illuminate/Database。然後,我們為 /tracks
創建一個控制器,以便所有以 /tracks
開頭的 URL 都將由 controllers/tracks.php 處理。 database.php 文件如下所示,請記住更改連接設置:
<?php require("../vendor/autoload.php"); $app = new Silex\Application(); $app['database'] = require("database.php"); $app->mount('/tracks', include 'controllers/tracks.php'); $app->run();
首先,我們使用 IlluminateDatabase 查詢構建器獲取 ID、名稱和藝術家的列表,然後輸出它們。輸出將具有以下格式:
<?php use Illuminate\Database\Capsule\Manager as Capsule; $capsule = new Capsule; $capsule->addConnection([ 'driver' => 'mysql', 'host' => 'localhost', 'database' => 'musicstore', 'username' => 'root', 'password' => '', 'charset' => 'utf8', 'collation' => 'utf8_unicode_ci', 'prefix' => '', ]); use Illuminate\Events\Dispatcher; use Illuminate\Container\Container; $capsule->setEventDispatcher(new Dispatcher(new Container)); $capsule->setAsGlobal(); $capsule->bootEloquent(); return $capsule;
(後續內容與原文類似,但會對語句進行調整和精簡,避免重複,並保持原意不變。) 由於篇幅限制,後續步驟(包括第一個API 版本、曲目信息、更新後的API 版本以及FAQ)的詳細代碼和解釋將被省略,但會保留關鍵步驟和思路概述。 讀者可以參考原文獲取完整的代碼和更詳細的解釋。
總而言之,通過在輸出之前添加 Fractal,可以輕鬆地進行數據庫更改,而不會影響最終用戶的體驗,從而維護 API 的穩定性和一致性。
以上是分形:實用的演練的詳細內容。更多資訊請關注PHP中文網其他相關文章!