library raml-php-parser

raml-org/raml-php-parser

A RAML parser built in php

, _(*1)

See the RAML specification., _(*2)

RAML 0.8 Support

For RAML 0.8 support follow version 2., _(*3)

RAML 1.0 Support

For RAML 1.0 support follow version 3 or above. RAML 1.0 support is still work in progress., _(*4)

What is done and should work: - Part of RAML 1.0 type expressions - Enums - Union type expression (the "or" | operator) - Array of types - discriminator and discriminatorValue facets - Traits inheritance, _(*5)

To be implemented: - Libraries - User defined facets - Full implementation of type expressions - The shorthand array and the union type have been implemented - Bi-dimensional array and the array-union combination have NOT been implemented yet. - Multiple inheritance - Annotations - Overlays and Extensions - Improved Security Schemes, _(*6)

Get started

Requires:, _(*7)

• composer (see https://getcomposer.org)

composer require raml-org/raml-php-parser

$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., _(*8)

Additional parsers and schema definitions can be created and passed into the Raml\Parser constructor, _(*9)

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:, _(*10)

$parser = new \Raml\Parser();
$api = $parser->parse('tests/fixture/simple.raml');

$routes = $api->getResourcesAsUri();

To return:, _(*11)

[
    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 the package:, _(*12)

• NoRouteFormatter which does nothing and simply echoes the result
• SymfonyRouteFormatter which adds the routes to a Symfony RouteCollection

Contributing

composer run-static-analysis
composer check-code-style
composer run-tests