fury

Fury.js

API Description SDK

Wardaddy: Best job I ever had.

Fury provides uniform interface to API description formats such as API Blueprint.

Usage

Install

Fury.js is available as npm module.

Install globally:

$ npm install -g fury

or as a dependency:

$ npm install --save fury

Interface

API Blueprint Parsing

In the interim period Fury.js offers only "legacy" interface for API Blueprint and Apiary Blueprint parsing:

var parser = require('fury').legacyBlueprintParser;
var source = '# My API\n';

parser.parse({ code: source }, function(error, api, warnings) {

    console.log(api.name);
});

Markdown Rendering

The legacy interface also offers access to Markdown rendered as used internally by API and Apiary Blueprint parsers.

var markdownRenderer = require('fury').legacyMarkdownRenderer;
var source = '# My API\n';


markdownRenderer.toHTML(source, {}, function(error, html) {

    console.log(html);
});