node package manager

protagonist

API Blueprint Parser

Protagonist

Protagonist is a Node.js wrapper for the Drafter library.

API Blueprint is Web API documentation language. You can find API Blueprint documentation on the API Blueprint site.

The best way to install Protagonist is by using its NPM package.

$ npm install protagonist

NOTE: Installing Protagonist depends on having Python 2 installed along with a compiler such as GCC, Clang or MSVC.

Tested with node.js ~0.8.15, 0.10.x, 0.12.x, 4, 6

var protagonist = require('protagonist');
 
protagonist.parse('# My API', function(errorresult) {
    if (error) {
        console.log(error);
        return;
    }
 
    console.log(result);
});

If you for some reason need to use the API synchronously, that is also possible. Please note that the recommended way is to use the asynchronous API as to not block the event loop.

var result = protagonist.parseSync('# My API');

Options can be passed to the parser as an optional second argument to both the asynchronous and synchronous interfaces:

var options = {
    generateSourceMap: true
}
protagonist.parse('# My API', options, callback);

The available options are:

Name Description
requireBlueprintName Require parsed blueprints have a title (default: false)
generateSourceMap Enable sourcemap generation (default: false)
type Set the output structure type as either ast or refract (default: refract)

Parsing this blueprint:

# GET /1
+ response

will produce the following object (result variable):

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

You are welcome to contribute. Use following steps to build & test Protagonist.

Protagonist uses node-gyp build tool.

  1. If needed, install node-gyp:

    $ npm install -g node-gyp
  2. Clone the repository, and fetch the submodules:

    $ git clone --recursive git://github.com/apiaryio/protagonist.git
    cd protagonist
    $ npm install
  3. Build:

    $ node-gyp configure
    $ node-gyp build

Inside the protagonist repository run:

$ npm test

Fork & Pull Request.

MIT License. See the LICENSE file.