API Elements: OpenAPI 2.0 Adapter


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

Install

``sh
$ npm install @apielements/openapi2
`

Usage

`js
import fury from 'fury';
import openApi2Parser from '@apielements/openapi2';

fury.use(openApi2Parser);

fury.parse({source: '... your OpenAPI 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);
});
`

$3

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

$3

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
- within the security-scheme object

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