API Blueprint Parser
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.
The best way to install Protagonist is by using its NPM package.
$ npm install protagonist
Works smoothly with node.js ~0.8.15, 0.10.x, 0.12.x and iojs v1.x.x
var protagonist = require'protagonist';protagonistparse'# My API'if errorconsole.logerror;return;console.logresultast;;
If you for some reason need to use the api synchronous, 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 = protagonistparseSync'# My API';
Parsing this blueprint:
# GET /1+ response
will produce the following object (
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 v3.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
length... Number of the characters from index where the warning occurs
You are welcome to contribute. Use following steps to build & test Protagonist.
Protagonist uses node-gyp build tool.
If needed, install node-gyp:
$ npm install -g node-gyp
Clone the repo + fetch the submodules:
$ git clone git://github.com/apiaryio/protagonist.git$ cd protagonist$ git submodule update --init --recursive$ npm install
$ node-gyp configure$ node-gyp build
Inside the protagonist repository run:
$ npm test
Fork & Pull Request.
MIT License. See the LICENSE file.