Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
protagonist
Advanced tools
Readme
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');
protagonist.parse('# My API', function(error, result) {
if (error) {
console.log(error);
return;
}
console.log(result.ast);
});
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 = protagonist.parseSync('# My API');
Parsing this blueprint:
# GET /1
+ response
will produce the following object (result
variable):
{
"ast": {
"_version": "3.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
}
]
}
]
}
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 – vnd.apiblueprint.ast.raw+json; version=3.0
.
warnings
... Array of the parser warnings as occurred during the parsing
code
... Warning group codemessage
... Warning messagelocation
... Array of (possibly non-continuous) locations in the source blueprint
index
... Zero-based index of the character where the warning occurslength
... Number of the characters from index where the warning occursYou 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
Build:
$ node-gyp configure
$ node-gyp build
Inside the protagonist repository run:
$ npm test
Fork & Pull Request.
MIT License. See the LICENSE file.
FAQs
API Blueprint Parser
We found that protagonist demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.