@swagger-api/apidom-parser-adapter-openapi-yaml-2

@swagger-api/apidom-parser-adapter-openapi-yaml-2

@swagger-api/apidom-parser-adapter-openapi-yaml-2 is a parser adapter for the OpenAPI 2.0 specification in YAML format. Under the hood this adapter uses apidom-parser-adapter-yaml-1-2 to parse a source string into generic ApiDOM in base ApiDOM namespace which is then refracted with OpenAPI 2.0 Refractors.

Installation

After prerequisites for installing this package are satisfied, you can install it via npm CLI by running the following command:

 $ npm install @swagger-api/apidom-parser-adapter-openapi-yaml-2

Parser adapter API

This parser adapter is fully compatible with parser adapter interface required by @swagger-api/apidom-parser and implements all required properties.

mediaTypes

Defines list of media types that this parser adapter recognizes.

[
    'application/vnd.oai.openapi;version=2.0',
    'application/vnd.oai.openapi+yaml;version=2.0',
]

detect

Detection is based on a regular expression matching required OpenAPI 2.0 specification symbols in YAML format.

namespace

This adapter exposes an instance of OpenAPI 2.0 ApiDOM namespace.

parse

parse function consumes various options as a second argument. Here is a list of these options:

Option	Type	Default	Description
specObj	Object	Specification Object	This specification object drives the YAML AST transformation to OpenAPI 2.0 ApiDOM namespace.
sourceMap	Boolean	false	Indicate whether to generate source maps.
refractorOpts	Object	{}	Refractor options are passed to refractors during refracting phase.

All unrecognized arbitrary options will be ignored.

Usage

This parser adapter can be used directly or indirectly via apidom-parser.

Direct usage

During direct usage you don't need to provide mediaType as the parse function is already pre-bound with supported media types.

import { parse, detect } from '@swagger-api/apidom-parser-adapter-openapi-yaml-2';

// detecting
await detect('swagger: "2.0"'); // => true
await detect('test'); // => false

// parsing
const parseResult = await parse('swagger: "2.0"', { sourceMap: true });

Indirect usage

You can omit the mediaType option here, but please read Word on detect vs mediaTypes before you do so.

import ApiDOMParser from '@swagger-api/apidom-parser';
import * as openApiYamlAdapter from '@swagger-api/apidom-parser-adapter-openapi-yaml-2';

const parser = new ApiDOMParser();

parser.use(openApiYamlAdapter);

const parseResult = await parser.parse('swagger: "2.0"', { mediaType: openApiYamlAdapter.mediaTypes.latest('yaml') });