protagonist

API Blueprint Parser

npm install protagonist
122 downloads in the last day
488 downloads in the last week
3 025 downloads in the last month

logo

Protagonist Build Status

API Blueprint Parser for Node.js

Protagonist is a Node.js wrapper for the Snow Crash library.

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

Install

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

$ npm install protagonist

Getting started

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

    console.log(result.ast);
});

Parsing Result

Parsing this blueprint:

# GET /1
+ response

will produce the following object (result variable):

{
  "ast": {
    "_version": "2.0",
    "metadata": [],
    "name": "",
    "description": "",
    "resourceGroups": [
      {
        "name": "",
        "description": "",
        "resources": [
          {
            "name": "",
            "description": "",
            "uriTemplate": "/1",
            "model": {},
            "parameters": [],
            "actions": [
              {
                "name": "",
                "description": "",
                "method": "GET",
                "parameters": [],
                "examples": [
                  {
                    "name": "",
                    "description": "",
                    "requests": [],
                    "responses": [
                      {
                        "name": "200",
                        "description": "",
                        "headers": [],
                        "body": "",
                        "schema": ""
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "warnings": [
    {
      "code": 6,
      "message": "missing response HTTP status code, assuming 'Response 200'",
      "location": [
        {
          "index": 12,
          "length": 9
        }
      ]
    }
  ]
}

Keys Description

  • ast ... This is the abstract syntax tree (AST) of the parsed blueprint.

    The structure under this key is 1:1 with the AST Blueprint serialization JSON media type v2.0vnd.apiblueprint.ast.raw+json; version=2.0.

  • warnings ... Array of the parser warnings as occurred during the parsing

    • code ... Warning group code
    • message ... Warning message
    • location ... Array of (possibly non-continuous) locations in the source blueprint
      • index ... Zero-based index of the character where the warning occurs
      • lenght ... Number of the characters from index where the warning occurs

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 repo + fetch the submodules:

     $ git clone git://github.com/apiaryio/protagonist.git
     $ cd protagonist
     $ git submodule update --init --recursive
    
  3. Build:

     $ node-gyp configure
     $ node-gyp build
    

Test

Inside the protagonist repository run:

$ npm install
$ npm test

Contribute

Fork & Pull Request.

License

MIT License. See the LICENSE file.

npm loves you