Skip to content

defconcepts/fury-adapter-swagger

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

96 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fury Swagger 2.0 Adapter

Build Status Coverage Status NPM version License

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

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.
4 Swagger validation error.

Errors:

Code Description
1 Error parsing input (e.g. malformed YAML).

About

Swagger 2.0 parser adapter for Fury.js

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%