README

PHP JSON API Library

Version 2 of our library for building HTTP JSON APIs in PHP.

Some major changes in version 2

• Adopt better code practices, allowing for Dependency Injection
• Adopt our new "Single Responsibility Controller" approach
• Decouple Router from JAPI container
• Use PSR logging
• Adopt PHP 5.4 minimum version

As we expand our Service Orientated Architecture (SOA) at Docnet, we're using this more and more - so I hope it's useful to someone else ;)

Intended to use HTTP status codes wherever possible for passing success/failure etc. back to the client.

Single Responsibility Controller

We've adopted a new (for us) take on routing and controller complexity in 2.0. As such, where previously, you might have had multiple actions (methods) on the same class like this:

• BasketController::fetchDetailAction()
• BasketController::addAction()
• BasketController::removeAction()
• BasketController::emptyAction()

Now this would be 4 name-spaced classes, like this

• Basket\FetchDetail
• Basket\Add
• Basket\Remove
• Basket\Empty

This allows for

• Greater code modularity
• Smaller classes
• Much easier Dependency Injection via __construct() as each "action" is it's own class.

You can still share common code via extension/composition - whatever takes your fancy!

JAPI will call the dispatch() method on your controller.

SOLID Routing

The bundled router will accept any depth of controller namespace, like this

• /one => One
• /one/two => One\Two
• /one/two/three => One\Two\Three

When you construct the Router, you can give it a "root" namespace, like this:

$router = new \Docnet\JAPI\SolidRouter('\\Docnet\\App\\Controller\\');

Which results in this routing:

• /one/two => \Docnet\App\Controller\One\Two

Static Routes

If you have some static routes you want to set up, that's no problem - they also bypass the routing regex code and so make calls very slightly faster.

Add a single custom route

$router = new \Docnet\JAPI\SolidRouter();
$router->addRoute('/hello', '\\Some\\Controller');

Or set a load of them

$router = new \Docnet\JAPI\SolidRouter();
$router->setRoutes([
    '/hello' => '\\Some\\Controller',
    '/world' => '\\Other\\Controller'
]);

Installation

Here's the require line for Composer users (during 2-series development)...

"docnet/php-japi": "2.0.*@dev"

...or just download and use the src folder.

Bootstrapping

Assuming...

• You've got Apache/whatever set up to route all requests to this file
• An auto-loader is present (like the Composer example here) or you've included all files necessary

...then something like this is all the code you need in your index.php

(new \Docnet\JAPI())->bootstrap(function(){

    $obj_router = new \Docnet\JAPI\SolidRouter();
    $obj_router->route();

    $str_controller = $obj_router->getController();
    return new $str_controller();

});

See the examples folder for a working demo (api.php).

Coding Standards

Desired adherence to PSR-2. Uses PSR-3 logging.