PHP Classes
elePHPant
Icontem

Swagger Slim Dispatcher: Dispatch requests to controllers defined in files

Recommend this page to a friend!
  Info   View files Example   View files View files (16)   DownloadInstall with Composer Download .zip   Reputation   Support forum (1)   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2018-01-12 (3 months ago) RSS 2.0 feedNot yet rated by the usersTotal: 53 This week: 1All time: 9,136 This week: 490Up
Version License PHP version Categories
swaggerslimdispatche 1.0.0GNU General Publi...5HTTP, PHP 5, Libraries, Language, Par...
Description Author

This package can dispatch requests to controllers defined in files.

It takes as configuration files with the definition of several routes that an application wants to handle.

The package can dispatch requests to the configured controllers classes.

Innovation Award
PHP Programming Innovation award winner
December 2017
Winner
Many MVC frameworks need to be configured using PHP code to map routes to controllers.

This package provides an alternative approach that consists in using separate files to define the way the framework can be configured, thus allowing easier application maintenance.

Manuel Lemos
  Performance   Level  
Name: Virgilio lino <contact>
Classes: 4 packages by
Country: Italy Italy
Age: 39
All time rank: 167667 in Italy Italy
Week rank: 395 Up20 in Italy Italy Up
Innovation award
Innovation award
Nominee: 3x

Winner: 1x

Details

SlimSwaggerDispatcher

Maybe it's about automation, or just about beign more declarative because a DSL non Touring complete language will just more correct, anyway I find it just amazing the possibility to describe an API by using the Open-API-Specification and let this specification be your code: this class will set every route using the Slim functionalities, and for every route point to a CommandHandler.

I'd suggest, the best way to see it in action is just to clone the repository and try the Example Hello World Application:

git clone git@github.com:virgiliolino/SwaggerSlimDispatcher.git
cd SwaggerSlimDispatcher/Examples/HelloWorld/
composer install   #composer install will actually install Slim and SwaggerSlimDispatcher
php -S localhost:8080 -t public public/index.php #start the server
curl localhost:8080/hello/world # or just open the browser localhost:8080/hello/world

For a fully working application, you could take a look at a ReactJS + Slim Skeleton that provides all the functionalities needed for a modern application. The url is here The OpenApi specification is here

You will not have a few overpopulated Controllers, but instead for every entry point a command handler. You can read at this blog post for some ideas of how we intend our architecutre

Furthermore, the Api specification from Swagger can be automatically validated, tested Swagger

In the end you'll have a yml or json file that describe your API, something like this: Json Specification

By using our library all routes will automatically be set. Every route pointing to a CommandHandler indicated by a unique operationId. So in the image of the example, you can see that there is a route: /pet that accept post requests. It will be enough to use our class, when you start the application the route /pet will accept a post. And so for the gets that you see below, like /pet/findByStatus, etc. For every path, it will be executed the command handler with the operationI. In the example for /pet, you can see the operationId: addPet. So making a post request to /pet, the system will try to execute the class AddPet::execute passing the params. The operationId must be a fully qualified name of a class. Something like this for example: operationId: \MyApplication\CommandHandlers\AddPett which means that will execue AddPett::execute

You may find an example of a fully working Open-Api specification here the full json file

Installation

Even if its working, I'd not consider it really a stable package. So to install it you need to proceed in that way:

 composer require dispatcher/swagger-dispatcher dev-master

Examples/Helloworld

$app = new \Slim\App;
$container = $app->getContainer();
$container['HelloWorld'] = function ($c) {
    return new \HelloWorld\CommandHandlers\HelloWorld();
};
       
$swaggerApiFile = 'routes.json';
$commandHandler = new Dispatcher\Swagger\DefaultCommandRegisterer();
$swaggerConfigParser = Dispatcher\Swagger\ParserFactory::parserFor($swaggerFile);
$swaggerConfig = $swaggerConfigParser->parse($swaggerFile);
\Dispatcher\Swagger\SwaggerDispatcher::InjectRoutesFromConfig($app, $swaggerConfig);

As you may see we're injecting HelloWorld, a command Handler with the same id of operationId that you may find on routes.json

That's all folks.

Help wanted

There is no validation at all. This process can be automatized. Class CommandHandler on the file called SwaggerDispatcher.

Thanks, Virgilio

  Files folder image Files  
File Role Description
Files folder imageDispatcher (1 directory)
Files folder imageExamples (1 directory)
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation
Accessible without login Image file swagger.png Data Auxiliary data

  Files folder image Files  /  Dispatcher  
File Role Description
Files folder imageSwagger (6 files, 1 directory)

  Files folder image Files  /  Dispatcher  /  Swagger  
File Role Description
Files folder imageParser (2 files)
  Plain text file CommandHandler.php Class Class source
  Plain text file CommandRegisterer.php Class Class source
  Plain text file DefaultCommandRegisterer.php Class Class source
  Plain text file Parser.php Class Class source
  Plain text file ParserFactory.php Class Class source
  Plain text file SwaggerDispatcher.php Class Class source

  Files folder image Files  /  Dispatcher  /  Swagger  /  Parser  
File Role Description
  Plain text file Json.php Class Class source
  Plain text file Yaml.php Class Class source

  Files folder image Files  /  Examples  
File Role Description
Files folder imageHelloWorld (3 files, 2 directories)

  Files folder image Files  /  Examples  /  HelloWorld  
File Role Description
Files folder imageHelloWorld (1 directory)
Files folder imagepublic (1 file)
  Accessible without login Plain text file composer.json Data Auxiliary data
  Accessible without login Plain text file routes.json Data Auxiliary data
  Accessible without login Plain text file routes.yaml Data Auxiliary data

  Files folder image Files  /  Examples  /  HelloWorld  /  HelloWorld  
File Role Description
Files folder imageCommandHandlers (1 file)

  Files folder image Files  /  Examples  /  HelloWorld  /  HelloWorld  /  CommandHandlers  
File Role Description
  Plain text file HelloWorld.php Class Class source

  Files folder image Files  /  Examples  /  HelloWorld  /  public  
File Role Description
  Accessible without login Plain text file index.php Example Example script

 Version Control Unique User Downloads Download Rankings  
 100%
Total:53
This week:1
All time:9,136
This week:490Up