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.
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
var protagonist = ;protagonist;
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;
Options can be passed to the parser as an optional second argument to both the asynchronous and synchronous interfaces:
var options =generateSourceMap: trueprotagonist;
The available options are:
||Require parsed blueprints have a title (default: false)|
||Enable sourcemap generation (default: false)|
Parsing this blueprint:
# GET /+ Response 204
will produce the following object (
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 repository, and fetch the submodules:$ git clone --recursive git://github.com/apiaryio/protagonist.git$ cd protagonist$ npm install
Build:$ node-gyp configure$ node-gyp build
Inside the protagonist repository run:
$ npm test
Fork & Pull Request.
MIT License. See the LICENSE file.