API Blueprint Parser
npm install protagonist-experimental!logo
API Blueprint is Web API documentation language. You can find API Blueprint documentation on the API Blueprint site.
``sh`
$ npm install protagonist
Works smoothly with node.js ~0.8.15, 0.10.x, 0.12.x and iojs v1.x.x
`js
var protagonist = require('protagonist');
protagonist.parse('# My API', function(error, result) {
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.
`js`
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:
`js`
var options = {
exportSourcemap: true
}
protagonist.parse('# My API', options, callback);
The available options are:
Name | Description
---------------------- | ----------------------------------------------------------
requireBlueprintName | Require parsed blueprints have a title (default: false)exportSourcemap | 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):
`json`
{
"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": []
}
]
}
]
}
]
}
]
}
]
}
]
}
1. If needed, install node-gyp:
`sh`
$ npm install -g node-gyp
2. Clone the repository, and fetch the submodules:
`sh`
$ git clone --recursive git://github.com/apiaryio/protagonist.git
$ cd protagonist
$ npm install
3. Build:
`sh`
$ node-gyp configure
$ node-gyp build
`sh``
$ npm test