@redocly/openapi-core

What is @redocly/openapi-core?

@redocly/openapi-core is a powerful tool for working with OpenAPI definitions. It provides functionalities for validating, bundling, and transforming OpenAPI documents, making it easier to manage and maintain API specifications.

What are @redocly/openapi-core's main functionalities?

Validation

This feature allows you to validate an OpenAPI document to ensure it adheres to the OpenAPI specification. The code sample demonstrates how to use the `validate` function to check an OpenAPI document.

const { validate } = require('@redocly/openapi-core');

async function validateOpenAPIDocument(document) {
  const result = await validate({ definition: document });
  console.log(result);
}

const openAPIDocument = { /* your OpenAPI document here */ };
validateOpenAPIDocument(openAPIDocument);

Bundling

This feature allows you to bundle multiple OpenAPI files into a single document. The code sample demonstrates how to use the `bundle` function to combine an OpenAPI document.

const { bundle } = require('@redocly/openapi-core');

async function bundleOpenAPIDocument(document) {
  const result = await bundle({ definition: document });
  console.log(result);
}

const openAPIDocument = { /* your OpenAPI document here */ };
bundleOpenAPIDocument(openAPIDocument);

Transforming

This feature allows you to transform an OpenAPI document based on specific options. The code sample demonstrates how to use the `transform` function to modify an OpenAPI document.

const { transform } = require('@redocly/openapi-core');

async function transformOpenAPIDocument(document, options) {
  const result = await transform({ definition: document, ...options });
  console.log(result);
}

const openAPIDocument = { /* your OpenAPI document here */ };
const transformOptions = { /* your transformation options here */ };
transformOpenAPIDocument(openAPIDocument, transformOptions);

Other packages similar to @redocly/openapi-core

swagger-parser

swagger-parser is a powerful tool for parsing, validating, and dereferencing Swagger and OpenAPI documents. It provides similar functionalities to @redocly/openapi-core, such as validation and dereferencing, but it does not offer as extensive transformation capabilities.

openapi-validator

openapi-validator is a package focused on validating OpenAPI documents. It provides comprehensive validation features but lacks the bundling and transformation functionalities offered by @redocly/openapi-core.

swagger-jsdoc

swagger-jsdoc is a tool for generating Swagger (OpenAPI) definitions from JSDoc comments in your code. While it focuses on generating OpenAPI documents rather than validating or transforming them, it can be used in conjunction with @redocly/openapi-core for a complete workflow.

README

openapi-core

See https://github.com/Redocly/redocly-cli

Basic usage

Lint

import { formatProblems, lint, loadConfig } from '@redocly/openapi-core';

const pathToEntryPoint = 'openapi.yaml';
const config = loadConfig('optional/path/to/.redocly.yaml');
const lintResults = await lint({ ref: pathToEntryPoint, config });

Bundle

import { formatProblems, bundle, loadConfig } from '@redocly/openapi-core';

const pathToEntryPoint = 'openapi.yaml';
const config = loadConfig('optional/path/to/.redocly.yaml');
const { bundle, problems } = await bundle({ ref: pathToEntryPoint, config });