README

已完成和应工作

• 属于RAML 1.0 类型表达式
• 枚举
• 联合类型表达式（"或" | 操作符）
• 类型数组
• discriminator 和 discriminatorValue 面板

仍然待办

• 库
• 用户自定义面板
• 完整实现 类型表达式
  • 简写数组和联合类型已经实现
  • 二维数组和数组-联合组合尚未实现。
• 多重继承
• 注释
• 覆盖和扩展
• 改进的安全方案

原始文档

将RAML文件解析成PHP对象。

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

开始使用

要求

• composer (查看 https://getcomposer.org.cn)

composer require elama/php-raml-parser

$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

待办事项

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

支持（我相信）

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