cozylife / php-raml-parser
A RAML parser built in php
Requires
- justinrainbow/json-schema: @dev
- oodle/inflect: 0.2.0
- symfony/routing: ~2.5
- symfony/yaml: ~2.5
Requires (Dev)
- phpunit/phpunit: 4.*
- satooshi/php-coveralls: ~0.6
- squizlabs/php_codesniffer: @dev
This package is auto-updated.
Last update: 2025-02-18 21:43:35 UTC
README
Parses a RAML file into a PHP object.
See the RAML spec here: https://github.com/raml-org/raml-spec
Differences in this fork
The original release of PHP RAML Parser merges the call data for each security call with the main request. That causes unnecessary overhead when, for example, requesting OAuth tokens, and can create unintended side-effects. This fork remedies that issue by keeping all calls independent.
See more about why this change is critical when making calls based on an API modeling language.
Get started
Requires:
- composer (see https://getcomposer.org)
composer install --dev
./vendor/bin/phpunit test
$parser = new \Raml\Parser(); $apiDef = $parser->parse($filename, true); $title = $apiDef->getTitle();
Parsing schemas
The library can convert schemas into an validation object. There is a default list, or they can be configured manually.
Each schema parser needs to conform to \Raml\Schema\SchemaParserInterface
and will return a instance of
\Raml\Schema\SchemaDefinitionInterface
.
Additional parsers and schema definitions can be created and passed into the \Raml\Parser
constructor
Exporting routes
It is also possible to export the entire RAML file to an array of the full endpoints. For example, considering a basic RAML, this can be returned using:
$parser = new Raml\Parser(); $api = $parser->parse('test/fixture/simple.raml'); $routes = $api->getResourcesAsUri();
To return:
[ GET /songs => ... POST /songs => ... GET /songs/{songId} => ... DELETE /songs/{songId} => ... ] $routes = $api->getResourcesAsUri(new Raml\RouteFormatter\NoRouteFormatter());
Route Formatters
There are two Route Formatters included in this package:
NoRouteFormatter
which does nothing and simply echoes the resultSymfonyRouteFormatter
which adds the routes to a SymfonyRouteCollection
Contributing
./vendor/bin/phpunit ./vendor/bin/phpunit --coverage-text ./vendor/bin/phpcs --standard=PSR1,PSR2 src
TODO
- Documentation/Markdown parser
- Date Representations?
- Parse RAML at provided URL
Supported (I Believe)
- Includes
- .yml/.yaml
- .raml/.rml
- .json (parsed using json-schema)
- Display Name
- Traits
- Resource Types