README

PHP的API Blueprint解析器

Oasis MSON解析器是PHP对Drafter库的封装。

API Blueprint是Web API文档语言。您可以在API Blueprint网站上找到API Blueprint文档。

安装

最佳安装方式是通过Composer。

$ composer require brianseitel/oasis-mson-parser

注意： Oasis MSON解析器依赖于Drafter库。请参阅该仓库的构建说明。

入门指南

签名

function parse(string $data, $format = 'json')

快速入门示例

<?php

require 'vendor/autoload.php';

$results = Oasis\Parser::parse('# My API', 'json');

解析结果

解析此蓝图

# GET /1
+ response

将生成以下对象（result变量）

{
  "element": "parseResult",
  "content": [
    {
      "element": "category",
      "meta": {
        "classes": [
          "api"
        ],
        "title": ""
      },
      "content": [
        {
          "element": "category",
          "meta": {
            "classes": [
              "resourceGroup"
            ],
            "title": ""
          },
          "content": [
            {
              "element": "resource",
              "meta": {
                "title": ""
              },
              "attributes": {
                "href": "/1"
              },
              "content": [
                {
                  "element": "transition",
                  "meta": {
                    "title": ""
                  },
                  "content": [
                    {
                      "element": "httpTransaction",
                      "content": [
                        {
                          "element": "httpRequest",
                          "attributes": {
                            "method": "GET"
                          },
                          "content": []
                        },
                        {
                          "element": "httpResponse",
                          "attributes": {
                            "statusCode": "200"
                          },
                          "content": []
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

贡献

Fork & Pull Request。

许可证

MIT许可证。请参阅LICENSE文件。