openapi-cleaner
v1.2.0
Published
A Node.js module for cleaning OpenAPI documents by removing unused components, reducing file size and improving readability.
Downloads
238
Maintainers
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.