@swagger-api/apidom-ns-openapi-3-1

What is @swagger-api/apidom-ns-openapi-3-1?

@swagger-api/apidom-ns-openapi-3-1 is an npm package designed to work with the OpenAPI 3.1 specification. It provides tools for parsing, validating, and manipulating OpenAPI documents, making it easier for developers to work with API definitions.

Parsing OpenAPI Documents

This feature allows you to parse an OpenAPI 3.1 document from a string format into a JavaScript object. This is useful for programmatically accessing and manipulating the contents of an OpenAPI document.

const { parse } = require('@swagger-api/apidom-ns-openapi-3-1');

const openApiDoc = `
openapi: 3.1.0
info:
  title: Sample API
  version: 1.0.0
paths:
  /pets:
    get:
      summary: List all pets
      responses:
        '200':
          description: A list of pets.
`;

const parsedDoc = parse(openApiDoc);
console.log(parsedDoc);

Validating OpenAPI Documents

This feature allows you to validate an OpenAPI 3.1 document to ensure it adheres to the specification. This is useful for catching errors and ensuring the document is correctly formatted.

const { validate } = require('@swagger-api/apidom-ns-openapi-3-1');

const openApiDoc = `
openapi: 3.1.0
info:
  title: Sample API
  version: 1.0.0
paths:
  /pets:
    get:
      summary: List all pets
      responses:
        '200':
          description: A list of pets.
`;

const validationResult = validate(openApiDoc);
console.log(validationResult);

Manipulating OpenAPI Documents

This feature allows you to manipulate an OpenAPI 3.1 document by parsing it into a JavaScript object, making changes, and then serializing it back into a string format. This is useful for programmatically updating API definitions.

const { parse, serialize } = require('@swagger-api/apidom-ns-openapi-3-1');

const openApiDoc = `
openapi: 3.1.0
info:
  title: Sample API
  version: 1.0.0
paths:
  /pets:
    get:
      summary: List all pets
      responses:
        '200':
          description: A list of pets.
`;

let parsedDoc = parse(openApiDoc);
parsedDoc.info.title = 'Updated API Title';
const updatedDoc = serialize(parsedDoc);
console.log(updatedDoc);

What is @swagger-api/apidom-ns-openapi-3-1?

What are @swagger-api/apidom-ns-openapi-3-1's main functionalities?

Other packages similar to @swagger-api/apidom-ns-openapi-3-1