OpenAPI-Format Playground

OpenAPI-Format Playground is a web-based tool for formatting, sorting, filtering, and applying overlays to OpenAPI documents.

The playground is powered by the openapi-format CLI to provide a user-friendly interface for developers to format & filter a OpenAPI specifications.

Features

• Format OpenAPI documents to enhance readability
• Sort OpenAPI document sections for consistency
• Filter OpenAPI document content
• Apply OpenAPI Overlay actions to OpenAPI document content
• Format the casing of OpenAPI elements
• Generate Operation ID's based a template syntax
• Support for both JSON and YAML formats
• Download formatted OpenAPI documents
• Share the OpenAPI document and configuration
• Compare the difference before and after the formatting

Usage

1. Paste your OpenAPI document into the input editor.
2. Configure the sorting and filtering options as needed.
3. View the formatted document in the output editor.
4. Download the formatted document using the download button.

Getting Started

Prerequisites

Before you begin, ensure you have the following installed on your system:

• Node.js (version 14 or higher)
• npm or yarn

Installation

1. Clone the repository:

   git clone https://github.com/thim81/openapi-format-playground.git
   cd openapi-format-playground

2. Install the dependencies:

npm install

or

yarn instal

3. Start the development server:

npm run dev

or

yarn dev

or

pnpm dev

4. Open http://localhost:3000 with your browser to start using the OpenAPI-format playground.