hmaus/reynaldo

将 API Blueprint Refract 解析为可迭代的 PHP 数据结构，以便更容易访问

维护者

详细信息

github.com/hendrikmaus/reynaldo

源代码

问题

安装量: 93,903

依赖者: 5

建议者: 0

安全性: 0

星标: 6

关注者: 6

分支: 8

公开问题: 1

v0.1.7 2021-05-09 13:01 UTC

Requires

  • php: >=7.0

Requires (Dev)

MIT de4ee5ff83aaf0a5ea6ffbee20eaf9218d3bf256

  • Hendrik Maus <aidentailor.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-09 19:54:28 UTC

README

将 API Blueprint Refract 解析结果（Drafter 输出）转换为可遍历的 PHP 数据结构。

codecov.io Code Climate

什么是 Reynaldo？

它应该可以简化处理 Drafter Refract 输出。

您读取 Drafter 解析结果，无论是 JSON 还是 YAML，将其转换为 PHP 关联数组，例如在 PHP 中使用 json_decode($parseresult, true)，然后将其传递给 \Hmaus\Reynaldo\Parser\RefractParser::parse。

得到一个易于遍历的对象。

您可以在 /example 中找到一个示例。

// load file and json_decode as assoc array into $apiDescription

$parser = new RefractParser();
$parseResult = $parser->parse($apiDescription);
$api = $parseResult->getApi();

// try to get the API title `$api->getApiTitle();`
// or the document description in markdown `$api->getApiDocumentDescription();`

foreach ($parseResult->getApi()->getResourceGroups() as $apiResourceGroup) {

    foreach ($apiResourceGroup->getResources() as $apiResource) {
    
        foreach ($apiResource->getTransitions() as $apiStateTransition) {
        
            foreach ($apiStateTransition->getHttpTransactions() as $apiHttpTransaction) {
                // inspect `$apiHttpTransaction->getHttpRequest()`, `$apiHttpTransaction->getHttpResponse()`
            }
        }
    }
}

要求

  • PHP 7.0 或更高版本

安装

推荐使用 composer 进行安装

$ composer require hmaus/reynaldo

这将安装与您的应用程序一起的 PHP 包。

许可证

Reynaldo 采用 MIT 许可证授权 - 详细信息请参阅 LICENSE 文件。