Download the PHP package docnet/php-japi without Composer
On this page you can find all versions of the php package docnet/php-japi. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download docnet/php-japi
More information about docnet/php-japi
Files in docnet/php-japi
Package php-japi
Short Description Simple framework for building HTTP JSON APIs in PHP
License
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-japi
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\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.
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:
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
Or set a load of them
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
See the examples folder for a working demo (api.php).
Coding Standards
All versions of php-japi with dependencies
ext-json Version *