@swagger-api/apidom-ns-openapi-2

@swagger-api/apidom-ns-openapi-2

@swagger-api/apidom-ns-openapi-2 contains ApiDOM namespace supports following OpenAPI specification versions:

• OpenAPI 2.0 specification

Installation

You can install this package via npm CLI by running the following command:

 $ npm install @swagger-api/apidom-ns-openapi-2

OpenAPI 2.0 namespace

OpenAPI 2.0 namespace consists of number of elements implemented on top of primitive ones.

import { createNamespace } from '@swagger-api/apidom-core';
import openApi2Namespace from '@swagger-api/apidom-ns-openapi-2';

const namespace = createNamespace(openApi2Namespace);

const objectElement = new namespace.elements.Object();
const swaggerElement = new namespace.elements.Swagger();

When namespace instance is created in this way, it will extend the base namespace with the namespace provided as an argument.

Elements from the namespace can also be used directly by importing them.

import { SwaggerElement, InfoElement } from '@swagger-api/apidom-ns-openapi-2';

const infoElement = new InfoElement();
const swaggerElement = new SwaggerElement();

Predicates

This package exposes predicates for all higher order elements that are part of this namespace.

import { isSwaggerElement, SwaggerElement } from '@swagger-api/apidom-ns-openapi-2';

const swaggerElement = new SwaggerElement();

isSwaggerElement(swaggerElement); // => true

Traversal

Traversing ApiDOM in this namespace is possible by using visit function from apidom package. This package comes with its own keyMap and nodeTypeGetter. To learn more about these visit configuration options please refer to @swagger-api/apidom-ast documentation.

import { visit } from '@swagger-api/apidom-core';
import { SwaggerElement, keyMap, getNodeType } from '@swagger-api/apidom-ns-openapi-2';

const element = new SwaggerElement();

const visitor = {
  SwaggerElement(swaggerElement) {
    console.dir(swaggerElement);
  },
};

visit(element, visitor, { keyMap, nodeTypeGetter: getNodeType });

Refractors

Refractor is a special layer inside the namespace that can transform either JavaScript structures or generic ApiDOM structures into structures built from elements of this namespace.

Refracting JavaScript structures:

import { InfoElement } from '@swagger-api/apidom-ns-openapi-2';

const object = {
    title: 'my title',
    description: 'my description',
    version: '0.1.0',
};

InfoElement.refract(object); // => InfoElement({ title, description, version })

Refracting generic ApiDOM structures:

import { ObjectElement } from '@swagger-api/apidom-core';
import { InfoElement } from '@swagger-api/apidom-ns-openapi-2';

const objectElement = new ObjectElement({
    title: 'my title',
    description: 'my description',
    version: '0.1.0',
});

InfoElement.refract(objectElement); // => InfoElement({ title = 'my title', description = 'my description', version = '0.1.0' })

Refractor plugins

Refractors can accept plugins as a second argument of refract static method.

import { ObjectElement } from '@swagger-api/apidom-core';
import { InfoElement } from '@swagger-api/apidom-ns-openapi-2';

const objectElement = new ObjectElement({
    title: 'my title',
    description: 'my description',
    version: '0.1.0',
});

const plugin = ({ predicates, namespace }) => ({
  name: 'plugin',
  pre() {
      console.dir('runs before traversal');
  },
  visitor: {
    InfoElement(infoElement) {
      infoElement.version = '2.0.0';
    },
  },
  post() {
      console.dir('runs after traversal');
  },
});

InfoElement.refract(objectElement, { plugins: [plugin] }); // => InfoElement({ title = 'my title', description = 'my description', version = '2.0.0' })

You can define as many plugins as needed to enhance the resulting namespaced ApiDOM structure. If multiple plugins with the same visitor method are defined, they run in parallel (just like in Babel).

Replace Empty Element plugin

This plugin is specific to YAML 1.2 format, which allows defining key-value pairs with empty key, empty value, or both. If the value is not provided in YAML format, this plugin compensates for this missing value with the most appropriate semantic element type.

import { parse } from '@swagger-api/apidom-parser-adapter-yaml-1-2';
import { refractorPluginReplaceEmptyElement, SwaggerElement } from '@swagger-api/apidom-ns-openapi-2';

const yamlDefinition = `
swagger: 2.0
info:
`;
const apiDOM = await parse(yamlDefinition);
const swaggerElement = SwaggerElement.refract(apiDOM.result, {
  plugins: [refractorPluginReplaceEmptyElement()],
});

// =>
// (SwaggerElement
//   (MemberElement
//     (StringElement)
//     (SwaggerVersionElement))
//   (MemberElement
//     (StringElement)
//     (InfoElement)))

// => without the plugin the result would be as follows:
// (SwaggerElement
//   (MemberElement
//     (StringElement)
//     (SwaggerVersionElement))
//   (MemberElement
//     (StringElement)
//     (StringElement)))

Implementation progress

Only fully implemented specification objects should be checked here.

• Swagger Object
• Info Object
• Contact Object
• License Object
• Paths Object
• Path Item Object
• Operation Object
• External Documentation Object
• Parameter Object
• Items Object
• Responses Object
• Response Object
• Headers Object
• Example Object
• Header Object
• Tag Object
• Reference Object
• JSON Reference Object
• Schema Object
• XML Object
• Definitions Object
• Parameters Definitions Object
• Responses Definitions Object
• Security Definitions Object
• Security Scheme Object
• Scopes Object
• Security Requirement Object
• Specification extensions

Changelog

0.87.0 (2023-12-12)

Features

• ls: add rules for OpenAPI 2.0 Swagger Object (#3527) (dfa91c2), closes #3104