Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

fury-adapter-apib-parser-js

apiaryio3MIT0.10.0

API Blueprint parser for Fury.js using drafter.js

readme

Fury API Blueprint Parser

Greenkeeper badge

Build Status Test Coverage NPM version License

This adapter provides support for parsing API Blueprint in Fury.js using the Node API Blueprint parser Drafter NPM.

Note

This is a fork of the https://github.com/apiaryio/fury-adapter-apib-parser project using drafter.js instead of the C++ version of drafter.

Install

npm install fury-adapter-apib-parser

Usage

import fury from 'fury';
import apibParser from 'fury-adapter-apib-parser';

fury.use(apibParser);

fury.parse({source: '... your API Blueprint ...'}, (err, result) => {
  if (err) {
    console.log(err);
    return;
  }

  // The returned `result` is a Minim parse result element.
  console.log(result.api.title);
});

changelog

0.10.0

Enhancements

0.9.0

0.8.0

  • Compatibility with minim 0.18 and Fury 3.0.0-beta.3.

0.7.0 - 2017-03-30

  • Upgraded babel-runtime dependency to v6
  • Drop support for node 0.12 and 0.10

0.6.1 - 2017-01-03

0.6.0 - 2016-11-16

Enhancement

  • Adds support for markdown suffix in apiblueprint content type;

0.5.0 - 2016-10-31

Enhancement

  • Adds support for API Blueprint validation.

0.4.0 - 2016-10-27

Enhancement

  • Adds support for the requireBlueprintName option during parsing. This option will validate that the blueprint has a name.

0.3.0 - 2016-07-19

Enhancement

  • Switches to use drafter-npm package for API Blueprint parsing.

0.2.1 - 2016-04-29

0.2.0 - 2015-09-14

0.1.0 - 2015-09-10

  • Initial release.