dmg-fury-adapter-swagger
Swagger 2.0 parser for Fury.js
Last updated 3 years ago by lorangf .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install dmg-fury-adapter-swagger 
SYNC missed versions from official npm registry.

Fury Swagger 2.0 Adapter

Build Status Test Coverage NPM version License

This adapter provides support for parsing Swagger 2.0 in Fury.js. It does not yet provide a serializer.

Try the Fury adapter in your browser to convert Swagger 2.0 documents into Refract elements.

Install

npm install fury-adapter-swagger

Usage

import fury from 'fury';
import swaggerAdapter from 'fury-adapter-swagger';

fury.use(swaggerAdapter);

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

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

Parser Codes

The following codes are used by the parser when creating warning and error annotations.

Warnings:

Code Description
2 Source maps are unavailable due either to the input format or an issue parsing the input.
3 Data is being lost in the conversion.

Errors:

Code Description
1 Error parsing input (e.g. malformed YAML).
4 Swagger validation error.
5 Swagger to Refract converter error (JS exception).

Swagger Vendor Extensions

Some Swagger Vendor extensions found in source Swagger documents are converted into the output API Element as extension elements.

The following locations of vendor extensions are supported:

  • within the info object
  • within the paths object
  • within the path-item object
  • within the operation object
  • within the responses object

These vendor extensions will be available as extensions using the relation https://help.apiary.io/profiles/api-elements/vendor-extensions/.

Current Tags

  • 0.15.0                                ...           latest (3 years ago)

1 Versions

  • 0.15.0                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 0
Dependencies (8)
Dev Dependencies (8)
Dependents (1)

Copyright 2014 - 2017 © taobao.org |