, (*1)
PHP JSON API Library
Version 2 of our library for building HTTP JSON APIs in PHP., (*2)
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, (*3)
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 ;), (*4)
Intended to use HTTP status codes wherever possible for passing success/failure etc. back to the client., (*5)
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:, (*6)
BasketController::fetchDetailAction()BasketController::addAction()BasketController::removeAction()BasketController::emptyAction()
Now this would be 4 name-spaced classes, like this, (*7)
Basket\FetchDetailBasket\AddBasket\RemoveBasket\Empty
This allows for
- Greater code modularity
- Smaller classes
- Much easier Dependency Injection via __construct() as each "action" is it's own class., (*8)
You can still share common code via extension/composition - whatever takes your fancy!, (*9)
JAPI will call the dispatch() method on your controller., (*10)
SOLID Routing
The bundled router will accept any depth of controller namespace, like this, (*11)
-
/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:, (*12)
$router = new \Docnet\JAPI\SolidRouter('\\Docnet\\App\\Controller\\');
Which results in this routing:, (*13)
-
/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., (*14)
Add a single custom route, (*15)
$router = new \Docnet\JAPI\SolidRouter();
$router->addRoute('/hello', '\\Some\\Controller');
Or set a load of them, (*16)
$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)..., (*17)
"docnet/php-japi": "2.0.*@dev", (*18)
...or just download and use the src folder., (*19)
Bootstrapping
Assuming..., (*20)
- 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, (*21)
(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)., (*22)
Coding Standards
Desired adherence to PSR-2. Uses PSR-3 logging., (*23)
Wallogit.com
