marmelab / microrest
Silex Provider that generates REST API from a RAML description file
Installs: 322
Dependents: 0
Suggesters: 0
Security: 0
Stars: 190
Watchers: 30
Forks: 24
Open Issues: 8
Requires
- php: >=5.4
- alecsammon/php-raml-parser: ~2.0
- doctrine/dbal: ~2.4
- pagerfanta/pagerfanta: ~1.0
- phpunit/dbunit: ~1.3
- silex/silex: ~1.2
Requires (Dev)
- phpunit/phpunit: ~4.2.0
- symfony/browser-kit: ~2.3
- symfony/css-selector: ~2.3
This package is not auto-updated.
Last update: 2020-06-26 18:27:25 UTC
README
Archived Repository This code is no longer maintained. Feel free to fork it, but use it at your own risks. |
Marmelab Microrest
Microrest is a Silex provider to setting up a REST API on top of a relational database, based on a YAML (RAML) configuration file.
Check out the launch post.
What is RAML ?
RESTful API Modeling Language (RAML) is a simple and succinct way of describing practically-RESTful APIs. It encourages reuse, enables discovery and pattern-sharing, and aims for merit-based emergence of best practices.
You can easily set up a RAML file from API Designer.
Installation
To install microrest.php library, run the command below and you will get the latest version:
composer require marmelab/microrest "~1.0@dev"
Enable ServiceController
, Doctrine
and Microrest
service providers in your application:
$app->register(new Silex\Provider\ServiceControllerServiceProvider()); $app->register(new Silex\Provider\DoctrineServiceProvider(), array( 'db.options' => array( 'driver' => 'pdo_sqlite', 'path' => __DIR__.'/app.db', ), )); $app->register(new Marmelab\Microrest\MicrorestServiceProvider(), array( 'microrest.config_file' => __DIR__ . '/api.raml', ));
You need to give the path to the RAML
file describing your API. You can find an example into the tests/fixtures
directory.
Then, browse your new API REST on the url defined in the baseUrl
configuration of your RAML
api file.
Tests
Run the tests suite with the following commands:
make install
make test
Demo
You can find a complete demo application in examples/ng-admin
. You just need 2 commands to install and run it:
make install-demo make run-demo
Play with the Silex demo API at the url: http://localhost:8888/api
Explore the API using ng-admin backend administration at the url: http://localhost:8888/admin
License
microrest.php is licensed under the MIT License, courtesy of marmelab.