Package detail

fury-adapter-apib-parser

apiaryio2.5kMITdeprecated0.18.1

fury-adapter-apib-parser has been renamed to @apielements/apib-parser

API Blueprint parser for Fury.js

readme

Fury API Blueprint Parser

NPM version License

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

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

Fury API Blueprint Parser Changelog

0.18.1 (2020-04-28)

Internal changes to the dependency tree to simplify package maintenance.

0.18.0 (2020-04-20)

Enhancements

0.17.0 (2019-12-06)

Enhancements

0.16.0 (2019-07-02)

Enhancements

0.15.0 (2019-06-11)

Breaking

  • Support for NodeJS 6 has been removed, upgrading to NodeJS 8 or newer is recommended.

0.14.0 (2019-03-26)

Enhancements

0.13.0 (2019-02-26)

Enhancements

0.13.0-beta (2019-01-10)

This update now uses drafter-npm 2.0.0-pre.1. Please see drafter-npm 2.0.0-pre.1 for the list of changes.

0.12.0 (2018-12-21)

Breaking

  • Node 4 is not supported anymore.
  • API Blueprint Parser now requires Fury 3.0.0 Beta 8.

Enhancements

  • Update minim to 0.22.1.

0.11.0

Enhancements

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)

Enhancements

  • Adds support for markdown suffix in apiblueprint content type;

0.5.0 (2016-10-31)

Enhancements

  • Adds support for API Blueprint validation.

0.4.0 (2016-10-27)

Enhancements

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

0.3.0 (2016-07-19)

Enhancements

  • 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.