Fractal: a Practical Walkthrough

API developers often face the challenge of database schema changes. Without a good implementation, modifying the column name may require refactoring the entire model. This article will demonstrate how to use Fractal as a bridge between the model and JSON output to simplify the API development process.

Key points:

• Fractal is a PHP project that acts as an intermediate layer between the model and JSON output, allowing the database schema to be modified without refactoring the entire model, thus simplifying API development.
• Fractal works with Composer and is part of The League of Extraordinary Packages, all of which meet the requirements of using PHP-FIG and unit test coverage.
• Fractal packages can use Silex and Illuminate/Database to set up environments and create frameworks. It requires creating a composer.json file with the necessary dependencies.
• By using Fractal before output, database changes can be easily made even when the underlying data pattern changes without being noticed by the end user, becoming a powerful tool for maintaining a consistent output structure.

Fractal bag

Fractal is a project written in PHP and belongs to The League of Extraordinary Packages. These packages meet multiple requirements, such as using PHP-FIG and unit testing coverage. Fractal is mainly developed by Phil Sturgeon and continues to receive regular improvements. It can also be used with Composer.

Set the environment

For demonstration, I will set up a framework using Silex and Illuminate/Database (Laravel's ORM component). Even if you are not familiar with any of them, it doesn't matter. What I will do is very simple and clear, and I will explain it as clearly as possible. If you have any unclear areas, please feel free to leave a message. I will start setting up the framework. Please note that if you don't want to follow the steps, you can download all the code at the end of the article. Now, create a new folder inside the root folder. We will start by creating a composer.json file that contains all the dependencies we need. In this case: Silex and IlluminateDatabase. Create a composer.json file like this:

{
  "require": {
    "silex/silex": "~1.2",
    "illuminate/database": "*"
  }
}

Use composer install to install these packages.

Database

I will take an online music database as an example. The database will provide information on multiple songs: song title, artist name, artist website, album title, release date and record label. At the beginning, all this information will be stored in a table. If you want to try it yourself, download the file 1.sql from the code base of this article and run it in your database.

Code

To use Silex with IlluminateDatabase, we need some code. Create a new file named index.php in the app folder. Here we will start Silex, connect to the database and define the route:

{
  "require": {
    "silex/silex": "~1.2",
    "illuminate/database": "*"
  }
}

The first line is to introduce the automatic loading file of Composer. Then we create a new Silex application and load Illuminate/Database. Then, we create a controller for /tracks so that all URLs starting with /tracks will be processed by controllers/tracks.php. The database.php file looks like this, remember to change the connection settings:

<?php
require("../vendor/autoload.php");

$app = new Silex\Application();

$app['database'] = require("database.php");

$app->mount('/tracks', include 'controllers/tracks.php');

$app->run();

First, we use the IlluminateDatabase query builder to get a list of IDs, names, and artists, and then output them. The output will have the following format:

<?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;

(The subsequent content is similar to the original text, but the statement will be adjusted and simplified to avoid duplication and keep the original intention unchanged.) Due to space limitations, the next steps (including the first API version, track Detailed code and explanation of information, updated API versions, and FAQ) will be omitted, but key steps and overviews of ideas will be retained. Readers can refer to the original text for the complete code and a more detailed explanation.

All in all, by adding Fractal before output, database changes can be easily made without affecting the end user experience, thus maintaining the stability and consistency of the API.

The above is the detailed content of Fractal: a Practical Walkthrough. For more information, please follow other related articles on the PHP Chinese website!