@swagger-api/apidom-parser-adapter-openapi-yaml-3-0

What is @swagger-api/apidom-parser-adapter-openapi-yaml-3-0?

@swagger-api/apidom-parser-adapter-openapi-yaml-3-0 is an npm package designed to parse OpenAPI 3.0 YAML documents. It is part of the ApiDOM project, which provides a set of tools for working with API descriptions in various formats.

What are @swagger-api/apidom-parser-adapter-openapi-yaml-3-0's main functionalities?

Parsing OpenAPI 3.0 YAML

This feature allows you to parse an OpenAPI 3.0 YAML document into a JavaScript object. The code sample demonstrates reading an OpenAPI YAML file, loading it into a JavaScript object using `js-yaml`, and then parsing it using the `parse` function from the package.

const { parse } = require('@swagger-api/apidom-parser-adapter-openapi-yaml-3-0');
const yaml = require('js-yaml');
const fs = require('fs');

const openApiYaml = fs.readFileSync('openapi.yaml', 'utf8');
const openApiDocument = yaml.load(openApiYaml);

parse(openApiDocument).then((parsed) => {
  console.log(parsed);
}).catch((error) => {
  console.error(error);
});

Other packages similar to @swagger-api/apidom-parser-adapter-openapi-yaml-3-0

swagger-parser

swagger-parser is a powerful npm package for parsing, validating, and dereferencing Swagger and OpenAPI definitions. It supports both JSON and YAML formats and provides more comprehensive validation and dereferencing capabilities compared to @swagger-api/apidom-parser-adapter-openapi-yaml-3-0.

openapi-parser

openapi-parser is another npm package for parsing and validating OpenAPI definitions. It focuses on providing a simple and lightweight solution for working with OpenAPI documents, similar to @swagger-api/apidom-parser-adapter-openapi-yaml-3-0, but with a broader focus on both JSON and YAML formats.

README

@swagger-api/apidom-parser-adapter-openapi-yaml-3-0

@swagger-api/apidom-parser-adapter-openapi-yaml-3-0 is a parser adapter for the OpenAPI 3.0.x 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 3.0.x 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-3-0

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=3.0.0',
  'application/vnd.oai.openapi+yaml;version=3.0.0',
  'application/vnd.oai.openapi;version=3.0.1',
  'application/vnd.oai.openapi+yaml;version=3.0.1',
  'application/vnd.oai.openapi;version=3.0.2',
  'application/vnd.oai.openapi+yaml;version=3.0.2',
  'application/vnd.oai.openapi;version=3.0.3',
  'application/vnd.oai.openapi+yaml;version=3.0.3',
]

detect

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

namespace

This adapter exposes an instance of OpenAPI 3.0.x 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 3.0.x 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-3-0';

// detecting
await detect('openapi: 3.0.3'); // => true
await detect('test'); // => false

// parsing
const parseResult = await parse('openapi: 3.0.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-3-0';

const parser = new ApiDOMParser();

parser.use(openApiYamlAdapter);

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

Changelog

1.0.0-alpha.8 (2024-08-08)

Features

• reference: loosen requirement for file extensions in parser plugins (#4299) (e4ddc6d), closes #4298