brianseitel/oasis-mson-parser

An MSON parser for PHP

Oasis MSON Parser

API Blueprint Parser for PHP

Oasis MSON Parser is a PHP wrapper for the Drafter library., _(*1)

API Blueprint is Web API documentation language. You can find API Blueprint documentation on the API Blueprint site., _(*2)

Install

The best way to install this is via Composer., _(*3)

$ composer require brianseitel/oasis-mson-parser

NOTE: Oasis MSON Parser depends on the Drafter library. Please see that repo for build instructions., _(*4)

Getting started

Signature

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

Quickstart Example

<?php

require 'vendor/autoload.php';

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

Parsing Result

Parsing this blueprint:, _(*5)

# GET /1
+ response

will produce the following object (result variable):, _(*6)

{
  "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": []
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Contribute

Fork & Pull Request., _(*7)

License

MIT License. See the LICENSE file., _(*8)