openapi-format

openapi-format

Format an OpenAPI document by ordering and filtering fields.

The openapi-format CLI can load an OpenAPI file, sorts the OpenAPI fields by ordering them in a hierarchical order, and can output the file with clean indenting, to either JSON or YAML.

Next to the ordering, the CLI provides additional options to filter fields & parts of the OpenAPI document based on flags, tags, methods, operationID's and even unused components.

Table of content

• Use-cases
• Features
• Installation
  • Local Installation (recommended)
  • Global Installation
  • NPX usage
• Command Line Interface
• OpenAPI format options
• OpenAPI sort configuration options
• OpenAPI filter options
• CLI sort usage
• CLI filter usage
• CLI rename usage
• CLI configuration usage
• Credits

Use-cases

Public documentation: An OpenAPI document is a specification that evolves and changes. To facilitate working with the specification and publishing the document as public documentation, you want to deliver a clean and structured specification. OpenAPI-format helps you to organize the fields by sorting and filtering specific elements from the OpenAPI like internal endpoints, beta tags, ... and even unused schemas, examples, responses, ... with a clean and optimized OpenAPI document as a result.

Maintenance: When working on large OpenAPI documents or with multiple team members, the file can be become messy and difficult to compare changes. By sorting it from time to time, the fields are all ordered in a structured manner, which will help you to maintain the file with greater ease.

CI/CD pipelines: OpenAPI-format can be useful in CI/CD pipelines, where the OpenAPI is used as the source for other documents like Web documentation, Postman collections, test suites, ...

Features

• Order OpenAPI fields in a default order
• Order OpenAPI fields in a custom order
• Order Components elements by alphabet
• Filter OpenAPI files based on methods
• Filter OpenAPI files based on flags
• Filter OpenAPI files based on flags values
• Filter OpenAPI files based on tags
• Filter OpenAPI files based on operationID's
• Filter OpenAPI files based on operations definition
• Strip flags from OpenAPI files
• Strip unused components from OpenAPI files
• Rename the OpenAPI title
• Support OpenAPI documents in JSON format
• Support OpenAPI documents in YAML format
• Format via CLI
• Format via config files
• Use as a Module
• Aligned YAML parsing style with Stoplight Studio style
• Support for OpenAPI 3.0
• Support for OpenAPI 3.1

Installation

Local Installation (recommended)

While possible to install globally, we recommend that you add the openapi-format CLI to the node_modules by using:

$ npm install --save openapi-format

or using yarn...

$ yarn add openapi-format

Note that this will require you to run the openapi-format CLI with npx openapi-format your-openapi-file.yaml or, if you are using an older versions of npm, ./node_modules/.bin/openapi-format your-openapi-file.yaml.

Global Installation

$ npm install -g openapi-format

NPX usage

To execute the CLI without installing it via npm, use the npx method

$ npx openapi-format your-openapi-file.yaml

Command Line Interface

openapi-format.js <input-file> -o [ouptut-file] [options]

Arguments:
  infile   the OpenAPI document, can be either a .json or .yaml file
  outfile  the output file is optional and be either a .json or .yaml file. Files that end in `.json` will be formatted 
  as JSON files that end in `.yaml` or `.yml` will be YAML format
  

Options:

  -o, --output         Save the formated OpenAPI file as JSON/YAML             [path]
  
  --sortFile           The file to specify custom OpenAPI fields ordering      [path]
  --filterFile         The file to specify filter setting                      [path]
    
  --no-sort            Don't sort the OpenAPI file                          [boolean]
  --sortComponentsFile The file with components to sort alphabetically         [path]
  
  --rename             Rename the OpenAPI title                              [string]

  --configFile         The file with all the format config options             [path]
  
  --lineWidth          Max line width of YAML output                         [number]
  
  --json               Prints the file to stdout as JSON                    [boolean]
  --yaml               Prints the file to stdout as YAML                    [boolean]
  
  --help               Show help                                            [boolean]
  --verbose            Output more details of the filter process              [count]

OpenAPI format options

Parameter	Alias	Description	Input type	Default	Required/Optional
file		the original OpenAPI file	path to file		required
--output	-o	save the formatted OpenAPI file as JSON/YAML	path to file		optional
--sortFile	-s	the file to specify custom OpenAPI fields ordering	path to file	defaultSort.json	optional
--filterFile	-f	the file to specify filter setting	path to file	defaultFilter.json	optional
--no-sort		don't sort the OpenAPI file	boolean	FALSE	optional
--sortComponentsFile		sort the items of the components (schemas, parameters, ...) by alphabet	path to file	defaultSortComponents.json	optional
--rename		rename the OpenAPI title	string		optional
--configFile	-c	the file with all the format config options	path to file		optional
--lineWidth		max line width of YAML output	number	-1 (Infinity)	optional
--json		prints the file to stdout as JSON		FALSE	optional
--yaml		prints the file to stdout as YAML		FALSE	optional
--verbose	-v, -vv, -vvv	verbosity that can be increased, which will show more output of the process			optional
--help	h	display help for command			optional

OpenAPI sort configuration options

The CLI will sort the OpenAPI document in the defined order liked defined per OpenAPI key/element. The fields that are not specified will keep their order like it is in the original OpenAPI document, so only defined fields will be re-ordered.

The default sorting based on the defined order (listed in the table below), which is stored in the defaultSort.json file.

You can easily modify this by specifying your own ordering per key, which can be passed on to the CLI (see below for an example on how to do this).

Key	Ordered by	OpenAPI reference
root	- openapi - info - servers - paths - components - tags - x-tagGroups - externalDocs	https://spec.openapis.org/oas/v3.0.3.html#openapi-object
get	- operationId - summary - description - parameters - requestBody - responses	https://spec.openapis.org/oas/v3.0.3.html#operationObject
post	- operationId - summary - description - parameters - requestBody - responses	https://spec.openapis.org/oas/v3.0.3.html#operationObject
put	- operationId - summary - description - parameters - requestBody - responses	https://spec.openapis.org/oas/v3.0.3.html#operationObject
patch	- operationId - summary - description - parameters - requestBody - responses	https://spec.openapis.org/oas/v3.0.3.html#operationObject
delete	- operationId - summary - description - parameters - requestBody - responses	https://spec.openapis.org/oas/v3.0.3.html#operationObject
parameters	- name - in - description - required - schema	https://spec.openapis.org/oas/v3.0.3.html#parameterObject
requestBody	- description - headers - content - links	https://spec.openapis.org/oas/v3.0.3.html#request-body-object
responses	- description - headers - content - links	https://spec.openapis.org/oas/v3.0.3.html#responses-object
content	(By alphabet)	https://spec.openapis.org/oas/v3.0.3.html#responses-object
components	- parameters - schemas	https://spec.openapis.org/oas/v3.0.3.html#components-object
schema	- description - type - items - properties - format - example - default	https://spec.openapis.org/oas/v3.0.3.html#schemaObject
schemas	- description - type - items - properties - format - example - default
properties	- description - type - items - format - example - default - enum

OpenAPI filter options

By specifying the desired filter values for the available filter types, the openapi-format CLI will strip out any matching item from the OpenAPI document. You can combine multiple types to filter out a range of OpenAPI items.

For more complex use-cases, we can advise the excellent https://github.com/Mermade/openapi-filter package, which has extended options for filtering OpenAPI documents.

Type	Description	Type	Examples
methods	a list OpenAPI methods.	array	['get','post','put']
tags	a list OpenAPI tags.	array	['pet','user']
operationIds	a list OpenAPI operation ID's.	array	['findPetsByStatus','updatePet']
operations	a list OpenAPI operations.	array	['GET::/pets','PUT::/pets']
flags	a list of custom flags	array	['x-exclude','x-internal']
flagValues	a list of custom flags with a specific value	array	['x-version: 1.0','x-version: 3.0']
unusedComponents	a list of unused components	array	['examples','schemas']
stripFlags	a list of custom flags that will be stripped	array	['x-exclude','x-internal']

Some more details on the available filter types:

=> methods: Refers to the "Path Item Object" http://spec.openapis.org/oas/v3.0.3.html#operationObject

This will remove all fields and attached fields that match the verbs. In the example below, this would mean that all get, put, post items would be removed from the OpenAPI document.

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
    /pets:
        get:
            summary: Finds Pets by status
        put:
            summary: Update an existing pet

=> tags: Refers to the "tags" field from the "Operation Object" https://spec.openapis.org/oas/v3.0.3.html#operationObject

This will remove all fields and attached fields that match the tags. In the example below, this would mean that all items with the tags pet or user would be removed from the OpenAPI document.

For example:

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
    /pets:
        put:
            tags:
                - pet
            summary: Update an existing pet

=> operationIds: Refers to the "operationId" field from the "Operation Object" https://spec.openapis.org/oas/v3.0.3.html#operationObject

This will remove specific fields and attached fields that match the operation ID's. In the example below, this would mean that the item with operationID findPetsByStatus would be removed from the OpenAPI document.

For example:

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
    /pets:
        get:
            operationId: findPetsByStatus

=> operations: Refers to a combination of a OpenAPI method & path from the "Path Object" https://spec.openapis.org/oas/v3.0.3.html#paths-object & "Path item" https://spec.openapis.org/oas/v3.0.3.html#path-item-object

This will remove specific path items that match the operation definition PUT::/pets. In the example below, this would mean that the item with the path '/pets' and method 'PUT' would be removed from the OpenAPI document.

For example:

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
    /pets:
        get:
            summary: Finds Pets by status
        put:
            summary: Update an existing pet

An operationId is an optional property. To offer support for OpenAPI documents that don't have operationIds, we have added the operation definition which is the unique combination of the OpenAPI method & path, with a :: separator symbol.

This will allow filtering for very specific OpenAPI items, without the need of adding operationIds to the OpenAPI document.

To facilitate managing the filtering, we have included wildcard options for the operations option, supporting the methods & path definitions.

REMARK: Be sure to put quotes around the target definition.

Strict matching example: "GET::/pets" This will target only the "GET" method and the specific path "/pets"

Method wildcard matching example: "*::/pets" This will target all methods ('get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace') and the specific path "/pets"

Path wildcard matching example: "GET::/pets/*" This will target only the "GET" method and any path matching any folder behind the "/pets", like "/pets/123" and "/pets/123/buy".

Method & Path wildcard matching example: "*::/pets/*" A combination of wildcards for the method and path parts is even possible.

=> flags: Refers to a custom property that can be set on any field in the OpenAPI document.

This will remove all fields and attached fields that match the flags. In the example below, this would mean that all items with the flag x-exclude would be removed from the OpenAPI document.

For example:

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
    /pets:
        get:
            x-exclude: true

=> flagValues: Refers to a flag, custom property which can be set on any field in the OpenAPI document, and the combination with the value for that flag.

This will remove all fields and attached fields that match the flag with the specific value.

A flagValues example:

flagValues:
    - x-version: 1.0
    - x-version: 3.0

In the example below, this would mean that all items with the flag x-version that matches x-version: 1.0 OR x-version: 3.0 would be removed from the OpenAPI document.

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
    /pets:
        get:
            x-version: 1.0

The filter option flagValues also will remove flags that contain an array of values in the OpenAPI document.

A flagValues example:

flagValues:
    - x-versions: 1.0
    - x-versions: 2.0

In the example below, this would mean that all items with the flag x-versions, which is an array, that match x-version: 1.0 OR x-version: 3.0 would be removed from the OpenAPI document.

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
    /pets:
        get:
            x-versions:
                - 1.0
                - 3.0
                - 5.0

Have a look at flagValues and flagValues for array values for a practical example.

=> unusedComponents: Refers to a list of reusable component types, from which unused items will be removed.

This option allows you to strip the OpenAPI document from any unused items of the targeted components types. Any item in the list of OpenAPI components that is not referenced as $ref, will get marked and removed from the OpenAPI document.

REMARK: We will recursively strip all unused components, with a maximum depth of 10 times. This means that "nested" components, that become unused, will also get removed

Supported component types that can be marked as "unused":

• schemas
• parameters
• examples
• headers
• requestBodies
• responses

=> stripFlags: Refers to a list of custom properties that can be set on any field in the OpenAPI document.

The stripFlags will remove only the flags, the linked parent and properties will remain. In the example below, this would mean that all flags x-exclude itself would be stripped from the OpenAPI document.

Example before:

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
    /pets:
        get:
          x-exclude: true
          summary: Finds Pets by status

Example after:

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
    /pets:
        get:
          summary: Finds Pets by status

CLI sort usage

• Format a spec with the default sorting and saves it as a new JSON file

$ openapi-format openapi.json -o openapi-formatted.json

• Format an OpenAPI JSON document with the default sorting and saves it as a new YAML file

$ openapi-format openapi.json -o openapi.yaml

• Format an OpenAPI document with the default sorting and output it as JSON to STDOUT

$ openapi-format openapi.json --json

• Format an OpenAPI document with the default sorting and output it as YAML to STDOUT

$ openapi-format openapi.json --yaml

• Format an OpenAPI JSON document with the default sorting and save it as YAML

$ openapi-format openapi.json -o openapi.yaml

• Format an OpenAPI document but skip the sorting and save it as a new JSON file

$ openapi-format openapi.json -o openapi-formatted.json --no-sort

This should keep the OpenAPI fields in the same order. This can be needed, when you only want to do a filtering or rename action.

• Format an OpenAPI document, including sorting all elements in the components section

$ openapi-format openapi.json -o openapi-formatted.json --sortComponentsFile ./test/json-sort-components/customSortComponents.json

This will sort all elements in the components ( components/schemas, components/parameters, components/headers, components/requestBodies, components/responses, ...) section by alphabet.

CLI filter usage

• Format an OpenAPI document by filtering fields, default sorting and saves it as a new file

When you want to strip certain methods ,tags, operationIds, operations, flags you can pass a filterFile which contains the specific values for the methods ,tags, operationIds, operations, flags.

This can be useful to combine with the sorting, to end up with an order and filtered OpenAPI document.

example:

$ openapi-format openapi.json -o openapi-formatted.json --filterFile customFilter.yaml

where the customFilter.yaml would contain a combination of all the elements you want to filter out.

flags:
    - x-visibility
flagValues: [ ]
tags: [ ]
operationIds:
    - addPet
    - findPetsByStatus

CLI rename usage

• Format an OpenAPI document by changing the title and saves it as a new JSON file

During CI/CD pipelines, you might want to create different results of the OpenAPI document. Having the option to rename them might make it easier to work with the results, so that is why we provide this command option.

$ openapi-format openapi.json -o openapi.json --rename "OpenAPI Petstore - OpenAPI 3.0"

which results in

• before

{
    "openapi": "3.0.2",
    "info": {
        "title": "Petstore - OpenAPI 3.0",

• after

{
    "openapi": "3.0.2",
    "info": {
        "title": "OpenAPI Petstore - OpenAPI 3.0",

CLI configuration usage

All the CLI options can be managed in a separate configuration file and passed along the openapi-format command. This will make configuration easier, especially in CI/CD implementations where the configuration can be stored in version control systems.

example:

$ openapi-format openapi.json --configFile openapi-format-options.json

The formatting will happen based on all the options set in the openapi-format-options.json file. All the available OpenAPI format options can be used in the config file.

AsyncAPI documents

For handling AsyncAPI documents, we have created a separate package asyncapi-format to allow customisation specific for AsyncAPI use-cases.

Stoplight Studio

We have adopted the YAML parsing style from Stoplight Studio, by leveraging the @stoplight/yaml package for handling the parsing of OpenAPI YAML files.

By using the Stoplight YAML parsing, the results will be slightly different from when using a normal YAML parsing library, like js-to-yaml. We appreciate the Stoplight Studio tool, since it is an excellent GUI for working with OpenAPI documents for non-OpenAPI experts who will be contributing changes. By adopting the Stoplight Studio YAML parsing, the potential risk of merge conflicts will be lower, which is the main reason why we opted for using the @stoplight/yaml package.

Credits

This package is inspired by the @microsoft.azure/format-spec from @fearthecowboy. The original code was not available on GitHub, with the last update was 3 years ago, so to improve support and extend it we tried to reproduce the original functionality.

The filter capabilities from openapi-format are a light version inspired by the work from @MikeRalphson on the https://github.com/Mermade/openapi-filter package.

Changelog

[1.6.1] - 2021-10-08

• Fix for issue with the markdown comments strip filtering when non-strings descriptions