Package Exports

openapi-cleaner
openapi-cleaner/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (openapi-cleaner) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Clean OpenAPI Documents

This module provides a Node.js utility to clean OpenAPI documents by removing unused components. It helps in reducing the file size and improving the readability of the API documents by eliminating clutter.

Installation

You can install the module using npm:

npm install openapi-cleaner

Features

Removes unused components from OpenAPI documents. Supports both JSON and YAML OpenAPI formats. Easy to integrate into build processes or CI/CD pipelines.

Usage

After installation, you can use the module to clean your OpenAPI document by running:

const openapicleaner = require('openapi-cleaner');

openapicleaner.cleanOpenApiFile('openapi.json', 'openapi_clean.json');

Contributing

Contributions are welcome! If you have suggestions for improvements or bug fixes, please open an issue or submit a pull request.