README

将 RAML 文件解析成 PHP 对象。

在此处查看 RAML 规范： https://github.com/raml-org/raml-spec

开始使用

要求

composer (见 https://getcomposer.org.cn)

composer install --dev
./vendor/bin/phpunit test

$parser = new \Raml\Parser();
$apiDef = $parser->parse($filename, true);

$title = $apiDef->getTitle();

解析架构

该库可以将架构转换为验证对象。有一个默认列表，也可以手动配置。每个架构解析器都需要符合 \Raml\Schema\SchemaParserInterface 并返回一个 \Raml\Schema\SchemaDefinitionInterface 实例。

可以创建额外的解析器和架构定义，并将它们传递给 \Raml\Parser 构造函数

导出路由

也可以将整个 RAML 文件导出到一个包含完整端点的数组中。例如，考虑一个基本的 RAML，这可以通过以下方式返回

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

$routes = $api->getResourcesAsUri();

[
	GET /songs => ...
	POST /songs => ...
	GET /songs/{songId} => ...
	DELETE /songs/{songId} => ...
]

$routes = $api->getResourcesAsUri(new Raml\RouteFormatter\NoRouteFormatter());

路由格式化器

此包中包含两个路由格式化器

NoRouteFormatter 什么都不做，只是简单地输出结果
SymfonyRouteFormatter 将路由添加到 Symfony 的 RouteCollection

贡献

./vendor/bin/phpunit
./vendor/bin/phpunit --coverage-text
./vendor/bin/phpcs --standard=PSR1,PSR2 src

TODO

文档/Markdown 解析器
日期表示？
在提供的 URL 上解析 RAML

支持（我相信）

包括
- .yml/.yaml
- .raml/.rml
- .json（使用 json-schema 解析）
显示名称
特质
资源类型

cnam / php-raml-parser

维护者

详细信息