Protagonist is Node.js wrapper for the API Blueprint parser
C++ CoffeeScript JavaScript API Blueprint Python Makefile
tjanc Merge pull request #209 from apiaryio/kylef/free-result
Free drafter parseResult from parseSync
Latest commit d40020c Aug 8, 2018

README.md

logo

Protagonist

Circle CI AppVeyor

API Blueprint Parser for Node.js

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.

Install

NOTE: For general use we recommend that you use the Drafter NPM package instead of Protagonist directly as Protagonist needs to be compiled which may not be possible in every situation

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 4, 6, 7

Getting started

var protagonist = require('protagonist');

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

    console.log(result);
});

Synchronous usage

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');

Parsing Options

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)

Parsing Result

Parsing this blueprint:

# GET /
+ Response 204

will produce the following object (result variable):

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

Hacking Protagonist

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

Build

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

Test

Inside the protagonist repository run:

$ npm test

Contribute

Fork & Pull Request.

License

MIT License. See the LICENSE file.