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中文网其他相关文章!