OpenAPI Sorter

A tool to sort OpenAPI specification files for better readability and consistency.

Features

• Sort paths alphabetically
• Sort schemas alphabetically (with special handling for system schemas)
• Sort properties within schemas

Installation

Global Installation

npm install -g openapi-sorter

Local Installation

npm install openapi-sorter

Usage

Command Line Interface

openapi-sorter ./path/to/your/openapi.json

Using Environment Variables

You can also use an environment variable to specify the file path:

1. Create a .env file in your project root with:

   TARGET_FILE_PATH=/path/to/your/openapi.json

2. Run the tool:

   npx openapi-sorter

How It Works

The tool reads your OpenAPI specification file, sorts the paths, schemas, and properties according to predefined rules, and then writes the sorted specification back to the file.