openapi-format

Format an OpenAPI document by ordering, formatting and filtering fields.

The openapi-format CLI can sort the OpenAPI fields by ordering them in a hierarchical order, format the casing of the fields and output cleanly indented JSON or YAML.

Additional features include powerful filtering options based on flags, tags, methods, operationIDs, and even unused components. To quickly standardize OpenAPI documents there is support for generating the operationIds.

The CLI can split large OpenAPI documents into modular, multi-file structures for easier management. For upgrades, the openapi-format CLI offers the option to convert an OpenAPI 3.0 document to OpenAPI 3.1.

Table of content

• Use-cases
• Features
• Online playground
• Installation
  • Local Installation (recommended)
  • Global Installation
  • NPX usage
• Command Line Interface
• OpenAPI format CLI options
• OpenAPI sort configuration options
• OpenAPI formatting configuration options
• OpenAPI filter options
• OpenAPI generate elements
• CLI sort usage
• CLI filter usage
• CLI generate usage
• CLI casing usage
• CLI split & bundle usage
• CLI rename usage
• CLI convertTo 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, formatting 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 & formatting from time to time, the fields are all ordered in a structured manner & properly cased, 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

• [x] Order OpenAPI fields in a default order
• [x] Order OpenAPI fields in a custom order
• [x] Order Components elements by alphabet
• [x] Format the casing (camelCase,PascalCase, ...) of component elements
• [x] Filter OpenAPI files based on methods
• [x] Filter OpenAPI files based on flags
• [x] Filter OpenAPI files based on flags values
• [x] Filter OpenAPI files based on tags
• [x] Filter OpenAPI files based on operationID's
• [x] Filter OpenAPI files based on operations definition
• [x] Filter OpenAPI files based on response content-types
• [x] Strip flags from OpenAPI files
• [x] Strip unused components from OpenAPI files
• [x] Generate OpenAPI elements for consistency
• [x] Bundle local and remote references in the OpenAPI document
• [x] Split the OpenAPI document into a multi-file structure
• [x] Convert OpenAPI 3.0 documents to OpenAPI 3.1
• [x] Rename the OpenAPI title
• [x] Support OpenAPI documents in JSON format
• [x] Support OpenAPI documents in YAML format
• [x] Format via CLI
• [x] Format via local or remote config files
• [x] Use as a Module
• [x] Aligned YAML parsing style with Stoplight Studio style
• [x] Support for OpenAPI 3.0
• [x] Support for OpenAPI 3.1 (beta)
• [x] Online playground (https://openapi-format-playground.vercel.app/)

Online playground

The OpenAPI-Format Playground is a web-based tool for formatting and sorting OpenAPI documents, powered by the openapi-format CLI.

More info about the features and usage, can be found in the readme.

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 [output-file] [options]

Arguments:
  input-file   the OpenAPI document can be a local or remote file in JSON or YAML format
  output-file  the output file is optional and can be either a .json or .yaml file. 

Options:

  --output, -o          Save the formated OpenAPI file as JSON/YAML             [path]

  --sortFile            The file to specify custom OpenAPI fields ordering      [path]
  --casingFile          The file to specify casing rules                        [path]
  --generateFile        The file to specify generate rules                      [path]
  --filterFile          The file to specify filter rules                        [path]

  --no-sort             Don't sort the OpenAPI file                          [boolean]
  --keepComments        Don't remove the comments from the OpenAPI YAML file [boolean]
  --sortComponentsFile  The file with components to sort alphabetically         [path]

  --no-bundle           Don't bundle the local and remote $ref               [boolean]
  --split               Split OpenAPI document into a multi-file structure   [boolean]
  
  --rename              Rename the OpenAPI title                              [string]
  
  --convertTo           convert the OpenAPI document to OpenAPI version 3.1   [string]

  --configFile          The file with the OpenAPI-format CLI 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]

  --playground, -p      Open config in online playground
  --help                Show help                                            [boolean]
  --version             Output the version number                            
  --verbose             Output more details of the filter process              [count]

OpenAPI format CLI options

| Parameter | Alias | Description | Input type | Default | Info | |----------------------|---------------|-----------------------------------------------------------------------------|--------------|----------------------------|----------| | file | | the OpenAPI document can be a local or remote file in JSON or YAML format | 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 | | --casingFile | -k | the file to specify casing setting | path to file | | optional | | --generateFile | -g | the file to specify generate rules | path to file | | optional | | --no-sort | | don't sort the OpenAPI file | boolean | FALSE | optional | | --keepComments | | don't remove the comments from the OpenAPI YAML file | boolean | FALSE | optional | | --sortComponentsFile | | sort the items of the components (schemas, parameters, ...) by alphabet | path to file | defaultSortComponents.json | optional | | --no-bunlde | | don't bundle the local and remote $ref in the OpenAPI document | boolean | FALSE | optional | | --split | | split the OpenAPI document into a multi-file structure | boolean | FALSE | optional | | --rename | | rename the OpenAPI title | string | | optional | | --convertTo | | convert the OpenAPI document to OpenAPI version 3.1 | 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 | | --playground | -p | open config in online playground | | | optional | | --version | | output the version number | | | 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/field/property/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 of the different fields based on the defined order (listed in the table below), which is stored in the defaultSort.json file.

OpenAPI sort fields

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 | openapi-object | | get | - operationId- summary- description- parameters- requestBody- responses | operationObject | | post | - operationId- summary- description- parameters- requestBody- responses | operationObject | | put | - operationId- summary- description- parameters- requestBody- responses | operationObject | | patch | - operationId- summary- description- parameters- requestBody- responses | operationObject | | delete | - operationId- summary- description- parameters- requestBody- responses | operationObject | | parameters | - name- in- description- required- schema | parameterObject | | requestBody | - description- headers- content- links | request-body-object | | responses | - description- headers- content- links | responses-object | | content | (By alphabet) | responses-object | | components | - parameters- schemas | components-object | | schema | - description- type- items- properties- format- example- default | schemaObject | | schemas | - description- type- items- properties- format- example- default | | | properties | - description- type- items- format- example- default- enum | |

Have a look at the folder yaml-default and compare the "output.yaml" (sorted document) with the "input.yaml" (original document), to see how openapi-format have sorted the OpenAPI document.

OpenAPI sort Paths

You can change the order of the paths defined in the OpenAPI specification and sort them alphabetically (path) or by the first tag of the first method (tags).

Options to sort by:

• original (default): keep the order as defined in the OpenAPI specification
• path: order the paths alphabetically by the path parts
• tags: order by the first tag of the first method

| Key | Options | OpenAPI reference | |-------------|------------------------------|------------------------------------------------------------------------| | sortPathsBy | 'original' / 'path' / 'tags' | paths-object |

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 | OpenAPI methods. | array | ['get','post','put'] | | inverseMethods | OpenAPI methods that will be kept | array | ['get','post','put'] | | tags | OpenAPI tags | array | ['pet','user'] | | inverseTags | OpenAPI tags that will be kept | array | ['pet','user'] | | operationIds | OpenAPI operation ID's | array | ['findPetsByStatus','updatePet'] | | inverseOperationIds | OpenAPI operation ID's that will be kept | array | ['findPetsByStatus','updatePet'] | | operations | OpenAPI operations | array | ['GET::/pets','PUT::/pets'] | | flags | Custom flags | array | ['x-exclude','x-internal'] | | inverseFlags | Custom flags that will kept | array | ['x-exclude','x-internal'] | | flagValues | Custom flags with a specific value | array | ['x-version: 1.0','x-version: 3.0'] | | inverseFlagValues | Custom flags with a value that will be kept | array | ['x-version: 1.0','x-version: 3.0'] | | responseContent | Response Content types | array | ['application/json','application/html'] | | inverseResponseContent | Response Content types that will kept | array | ['application/ld+json'] | | requestContent | Request Body Content types | array | ['application/json','application/html'] | | inverseRequestContent | Request Body Content types that will kept | array | ['application/ld+json'] | | unusedComponents | Unused components | array | ['examples','schemas'] | | stripFlags | Custom flags that will be stripped | array | ['x-exclude','x-internal'] | | preserveEmptyObjects | Preserve empty object | boolean | true OR ['schema'] | | textReplace | Search & replace values to replace | array | [{'searchFor':'Pet','replaceWith':'Dog'}] |

Some more details on the available filter types:

Filter - methods/inverseMethods

=> methods: Refers to the Path Item Object

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

=> inverseMethods: This option does the inverse filtering, by keeping only the verbs defined and remove all other verbs.

Filter - tags

=> 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

=> inverseTags: This option does the inverse filtering, by keeping only the tags defined and remove all other tags, including the operations without a tags.

Filter - operationIds

=> operationIds: Refers to the "operationId" field from the Operation Object

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

=> inverseTags: This option does the inverse filtering, by keeping only the operationIds defined and remove all other operationIds, including the operations without an operationId.

Filter - operations

=> operations: Refers to a combination of a OpenAPI method & path from the Path Object & Path item

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.

Filter - flags/inverseFlags

=> 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

=> inverseFlags: This option does the inverse filtering, by keeping only the operations, components, tags, x-tagGroups that match the flag(s). This is a very aggressive option to keep only the items that are needed.

Filter - flagValues/inverseFlagValues

=> 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.

=> inverseFlagValues: This option does the inverse filtering, by keeping only the operations, components, tags, x-tagGroups that match the flag with the specific value. This is a very aggressive option to keep only the items that are needed.

Filter - responseContent/inverseResponseContent

=> ResponseContent: Refers to the Response Object's content

A responses content filter example:

responseContent:
  - application/json

This will remove all the content that match the media types from the responses. In the example below, this would mean that all application/json content items would be removed from the OpenAPI document

Example before:

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
  /pet:
    post:
      tags:
        - pet
      summary: Add a new pet to the store
      description: Add a new pet to the store
      operationId: addPet
      x-visibility: true
      responses:
        '200':
          description: Successful operation
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Pet'
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
        '405':
          description: Invalid input

Example after:

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
  /pet:
    post:
      tags:
        - pet
      summary: Add a new pet to the store
      description: Add a new pet to the store
      operationId: addPet
      x-visibility: true
      responses:
        '200':
          description: Successful operation
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Pet'
        '405':
          description: Invalid input

=> inverseResponseContent: This option does the inverse filtering, by keeping only the content with media types defined and remove all other content.

Filter - requestContent/inverseRequestContent

=> requestContent: Refers to the Request Body Object's content

A request body content filter example:

requestContent:
  - application/json

This will remove all the content that match the media types from the request body. In the example below, this would mean that all application/json content items would be removed from the OpenAPI document.

Example before:

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
  /pet:
    post:
      tags:
        - pet
      summary: Add a new pet to the store
      description: Add a new pet to the store
      operationId: addPet
      x-visibility: true
      requestBody: 
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Pet'
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'

Example after:

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
  /pet:
    post:
      tags:
        - pet
      summary: Add a new pet to the store
      description: Add a new pet to the store
      operationId: addPet
      x-visibility: true
      requestBody:
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Pet'

=> inverseRequestContent: This option does the inverse filtering, by keeping only the content with media types defined and remove all other content types from the request body.

Filter - unusedComponents

=> 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

Filter - textReplace

=> textReplace: "search & replace" option to replace text in the OpenAPI specification

The textReplace provides a "search & replace" method, that will search for a text/word/characters in the OpenAPI description, summary, URL fields and replace it with another text/word/characters. This is very useful to replace data in the OpenAPI specification.

A textReplace example:

textReplace:
    - searchFor: 'Pets'
      replaceWith: 'Dogs'
    - searchFor: 'swagger.io'
      replaceWith: 'openapis.org'

This will replace all "Pets" with "Dogs" & "swagger.io" with "openapi.org" in the OpenAPI document.

Filter - stripFlags

=> 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

Filter - preserveEmptyObjects

=> preserveEmptyObjects: Refers to any properties of your OpenAPI document, from which empty object values would be kept.

The preserveEmptyObjects will preserve all empty objects if set to true.

You can also pass a list of keys from which preserve empty objects. For instance a ['schema'] value would only prevent removal of empty objects having for key schema.

REMARK: Please note that openapi-format default behavior is to remove all empty objects from your document, except for items of examples, security, schemas, default, oneOf, allOf.

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
    /pets:
        post:
          requestBody:
            description: Create a new pet in the store
            required: true
            content:
              application/json:
                schema: {}

Example after (with preserveEmptyObjects: false):

openapi: 3.0.0
info:
    title: API
    version: 1.0.0
paths:
    /pets:
        post:
          requestBody:
            description: Create a new pet in the store
            required: true
            content:
              application/json: {}

OpenAPI formatting configuration options

Tools like spectral or speccy, or any of the linting tools, provide a manner to validate & lint OpenAPI specifications to be uniform. The linting tool informs about the incorrect usage of OpenAPI properties & inconsistent field names. This is very useful and helps to guard the quality of the OpenAPI specification. They inform which fields to correct so that the specification will comply with all the defined linting rules.

The openapi-format CLI formatting option can assist with keeping the field names consistent by automatically changing the casing of the properties/keys/names for the different elements in the OpenAPI document. The desired casing can be defined per OpenAPI key/element (see list below). The keys that are not specified will keep their casing like it is in the original OpenAPI document, so only for defined fields, the casing will be changed.

| Key | Description | OpenAPI reference | |----------------------------|------------------------------------------------------------------------------------------------------| ------------------------------------------------------------------------- | | operationId | Changes operation ID's that are part of the Operations Object | operation-object| | properties | Changes property keys of the schemas of the inline response/requestBody & components | schemaObject | | parametersCookie | Changes the cookie name of the parameters inline & models in the components | parameter-object | | parametersPath | Changes the path name of the parameters inline & models in the components | parameter-object | | parametersHeader | Changes the header name of the parameters inline & models in the components | parameter-object | | parametersQuery | Changes the query name of the parameters inline & models in the components | parameter-object | | componentsParametersCookie | Changes the key of the cookie models in the components parameters sections & "$ref" links | components-object | | componentsParametersPath | Changes the key of the path models in the components parameters sections & "$ref" links | components-object | | componentsParametersQuery | Changes the key of the query models in the components parameters sections & "$ref" links | components-object | | componentsParametersHeader | Changes the key of the header models in the components parameters sections & "$ref" links | components-object | | componentsSchemas | Changes the key of the schema models in the components sections & "$ref" links | components-object | | componentsExamples | Changes the key of the example models in the components sections & "$ref" links | components-object | | componentsHeaders | Changes the key of the header models in the components sections & "$ref" links | components-object | | componentsResponses | Changes the key of the response models in the components sections & "$ref" links | components-object | | componentsRequestBodies | Changes the key of the request body models in the components sections & "$ref" links | components-object | | componentsSecuritySchemes | Changes the key of the security schemes in the components sections & "$ref" links | components-object |

Casing options

| Casing type | Casing alias | Description | Example | | -----------------| ------------ | ------------------------------------------------- | --------------- | | 🐪 camelCase | camelCase | converts a strings to camelCase | openapiFormat | | 👨‍🏫 PascalCase | PascalCase | converts a strings to PascalCase | OpenapiFormat | | 🥙 kebab-case | kebabCase | converts a strings to kebab-case | openapi-format | | 🚂 Train-Case | TrainCase | converts a strings to Train-Case | Openapi-Format | | 🐍 snake_case | snakeCase | converts a strings to snake_case | openapi_format | | 🕊 Ada_Case | AdaCase | converts a strings to Ada_Case | Openapi_Format | | 📣 CONSTANT_CASE | constantCase | converts a strings to CONSTANT_CASE | OPENAPI_FORMAT | | 👔 COBOL-CASE | cobolCase | converts a strings to COBOL-CASE | OPENAPI-FORMAT | | 📍 Dot.notation | dotNotation | converts a strings to Dot.notation | openapi.format | | 🛰 Space case | spaceCase | converts a strings to Space case (with spaces) | openapi format | | 🏛 Capital Case | capitalCase | converts a strings to Capital Case (with spaces)| Openapi Format | | 🔡 lower case | lowerCase | converts a strings to lower case (with spaces) | openapi format | | 🔠 UPPER CASE | upperCase | converts a strings to UPPER CASE (with spaces) | OPENAPI FORMAT |

REMARK: All special characters are stripped during conversion, except for the @ and $, since they can be part of the query strings.

The casing options are provided by the nano NPM case-anything package.

Format casing - operationId

=> operationId: Refers to the operationId properties in the OpenAPI document.

Formatting casing example:

operationId: kebab-case

Example before:

openapi: 3.0.3
paths:
    /pets:
        get:
          operationId: getPets

openapi-format will format the "getPets" from the original camelcase to kebab-case.

Example after:

openapi: 3.0.3
paths:
    /pets:
        get:
          operationId: get-pets

Format casing - model & schema properties

=> properties: Refers to all the schema properties, that are defined inline in the paths request bodies & responses and the models in the components section of the OpenAPI document.

Formatting casing example:

properties: snake_case

Example before:

openapi: 3.0.3
components:
    schemas:
        UserModel:
            type: object
            properties:
                id:
                    type: integer
                    example: 10
                emailAddress:
                    type: string
                    example: [email protected]
                firstName:
                    type: string
                    example: John

The CLI will format all the properties like: "id", "username", "firstName" from the original camelcase to snake_case.

Example after:

openapi: 3.0.3
components:
    schemas:
        UserModel:
            type: object
            properties:
                id:
                    type: integer
                    example: 10
                email_address:
                    type: string
                    example: [email protected]
                first_name:
                    type: string
                    example: John

Format casing - component keys

=> componentsSchemas / componentsExamples / componentsParametersCookie / componentsParametersHeader / componentsParametersQuery / componentsParametersQuery / componentsParametersPath / componentsHeaders / componentsResponses / componentsRequestBodies / componentsSecuritySchemes: Refers to all the model objects that are defined in the components section of the OpenAPI document.

Formatting casing example:

componentsSchemas: PascalCase

Example before:

openapi: 3.0.3
paths:
    /orders:
        get:
            responses:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/order-model'
components:
    schemas:
        userModel:
            type: object
        order-model:
            type: object
        pet_model:
            type: object

openapi-format will format all the component keys like: "userModel", "order-model", "pet_model" to PascalCase, including formatting all the "$ref" used in the OpenAPI document.

Example after:

openapi: 3.0.3
paths:
    /orders:
        get:
            responses:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/OrderModel'
components:
    schemas:
        UserModel:
            type: object
        OrderModel:
            type: object
        PetModel:
            type: object

Format casing - parameter names

=> componentsParametersCookie / componentsParametersPath / componentsParametersQuery / componentsParametersHeader: Refers to "name" in the Parameters types: Path, Query or Header, which can be defined inline in the Path or as a reference in the components of the OpenAPI document.

Formatting casing example:

componentsParametersPath: kebab-case

Example before:

openapi: 3.0.3
paths:
    '/pet/{petId}':
        get:
            parameters:
                - name: petId
                  in: path
                  description: ID of pet to return
                - $ref: '#/components/parameters/LimitParam'
components:
    parameters:
        LimitParam:
            name: limitParam
            in: query
            description: max records to return

The CLI will format the "name" of the parameters: Path, Query or Header like: "petId", "limitParam" to kebab-case in the OpenAPI document.

Example after:

openapi: 3.0.3
paths:
    '/pet/{petId}':
        get:
            parameters:
                - name: pet-id
                  in: path
                  description: ID of pet to return
               - $ref: '#/components/parameters/LimitParam'
components:
    parameters:
        LimitParam:
            name: limit-param
            in: query
            description: max records to return

OpenAPI Generate Options

The OpenAPI formatting tool allows you to generate various elements such as operationId, and more using customizable templates. These templates enable dynamic generation of missing or incomplete values in your OpenAPI specification, ensuring consistency and adherence to your conventions.

Options for generating elements:

• operationIdTemplate: Generate the operationId using placeholders like <method>, <pathPart2>, etc.
• overwriteExisting: Set to true or false to control whether existing values should be overwritten (default: false).

| Key | Options | OpenAPI Reference | |---------------------|--------------------------------|--------------------------------------------------------------------------------| | operationIdTemplate | Customizable with placeholders | operation-object | | overwriteExisting | true / false | N/A |

See CLI generate usage for an example and the available template options.

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 a remote spec with the default sorting and saves it as a new JSON file

$ openapi-format https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/api-with-examples.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 using a configuration file containing all the options that would otherwise be passed via the CLI.

$ openapi-format openapi.yaml --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.

• 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.

• Convert the OpenAPI 3.0 document to OpenAPI 3.1 but skip the sorting and save it as a new YAML file

$ openapi-format openapi.yaml -o openapi-3.1.yaml --no-sort --convertTo "3.1"

This will convert the OpenAPI 3.0 document into version 3.1 of OpenAPI, without any ordering or filtering. During the conversion, openapi-format will transform all OpenAPI 3.0 properties into the OpenAPI 3.1 properties, as described in the migration guide from Phil Sturgeon.

• 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 generate usage

• Generate OpenAPI elements and saves it as a new file

The OpenAPI formatting tool allows you to generate OpenAPI elements, such as operationId, summary, and more, based on configurable templates. The generated elements will be saved to the output OpenAPI file.

You can also combine generation with filtering and sorting to customize the output.

example:

$ openapi-format openapi.json -o openapi-formatted.json --generateFile customGenerate.yaml

where the customGenerate.yaml would contain a combination of all the elements you to generate.

operationIdTemplate: "<method>_<pathPart2>"
overwriteExisting: false

Template Options: In the customGenerate.yaml, you can define templates for various OpenAPI properties using dynamic placeholders. These placeholders will be replaced by actual values from the OpenAPI operations. Below is a list of available placeholders and what they represent:

• <operationId> : The operationId of the OpenAPI operation. Example: leadsAll
• <method> : The HTTP method of the OpenAPI operation. Example: GET
• <path> : The path of the OpenAPI operation. Example: /crm/leads
• <pathRef> : The path reference of the OpenAPI operation. Example: GET::/crm/leads
• <tag> : The first tag name of the OpenAPI operation. Example: Leads
• <tag1> : The first tag name of the OpenAPI operation. Example: Leads
• <tag2> : The second tag name of the OpenAPI operation, if more than one tag is defined. Example: CRM
• <tagn> : The nth tag name of the OpenAPI operation if more than one tag is defined.
• <pathPart1> : The first part of the path of the OpenAPI operation. Example: crm
• <pathPart2> : The second part of the path of the OpenAPI operation. Example: leads
• <pathPartn> : The nth part of the path of the OpenAPI operation.

You can also include static text in the templates, which will be merged with the dynamic placeholders. For example:

operationIdTemplate: "Prefix_<method>_<pathPart2>_Handler"

Configuration Options:

• operationIdTemplate: Template for generating operationId. Use dynamic placeholders like and .
• overwriteExisting: Set to true or false to control whether existing values should be overwritten. Default: false.

CLI casing usage

• Generate OpenAPI elements and saves it as a new file

The OpenAPI formatting tool allows you to enforce consistent casing styles across various OpenAPI elements, such as operationId, summary, parameters, and more. The specified casing preferences will be applied to the relevant elements and saved to the output OpenAPI file.

example:

$ openapi-format openapi.json -o openapi-formatted.json --casingFile customCasing.yaml

where the customCasing.yaml would contain a casing preferences for the specified of the elements.

In this example, the customCasing.yaml file would contain the desired casing preferences for specific OpenAPI elements.

operationId: snake_case
properties: camelCase

parametersQuery: kebab-case
parametersHeader: kebab-case
parametersPath: snake_case

componentsExamples: PascalCase
componentsSchemas: camelCase
componentsHeaders: kebab-case
componentsResponses: snake_case
componentsRequestBodies: snake_case
componentsSecuritySchemes: PascalCase

componentsParametersQuery: snake_case
componentsParametersHeader: kebab-case
componentsParametersPath: camelCase

Casing Options: In the customCasing.yaml, you can define the casing style for various OpenAPI properties, allowing you to customize the appearance of your document consistently.

• operationId: Defines the casing for operation IDs. Example: snake_case, PascalCase, or camelCase.
• properties: Sets the casing for properties within components. Example: camelCase.
• parametersQuery, parametersHeader, parametersPath: Define different casing styles for parameters based on their location (query, header, path). Example: snake_case, kebab-case.
• and many more

See OpenAPI formatting configuration options for the full list of casing options

CLI Bundle & Split usage

• Bundling: Create a self-contained OpenAPI file that can be used for documentation generation or API validation tools that don't support external references.

• Splitting: Generate a modular OpenAPI structure during development or testing, making it easier to manage changes to individual paths or components without altering the entire document.

Splitting the OpenAPI Document

The --split option splits the OpenAPI document into a modular multi-file structure. This structure makes it easier to manage larger specifications by separating paths, components (schemas, paramaters, ...) into individual files.

Example: Splitting the Document

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

This command will take the openapi.json and split it into multiple files, stored under the ./openapi-split/ directory.

The resulting structure might look like this:

./openapi-split/
├── openapi.yaml
├── paths/
│   ├── /pets.yaml
│   └── /pets/{petId}.yaml
├── components/
├── schemas/
│   ├── Pet.yaml
│   └── Error.yaml
├── parameters/
│   └── petId.yaml

The main openapi.yaml file will contain references to these newly created files using $ref, making the structure modular and easier to navigate.

Bundling the OpenAPI Document

The --no-bundle option allows you to control whether local and remote $ref references are bundled into the final document.

By default, all $ref references are dereferenced, resulting in a single, self-contained OpenAPI file. However, in some cases, you might prefer to keep the $ref references intact, especially if you're working with external references or want to maintain a modular structure.

Example: Default Bundling

$ openapi-format input.json -o bundled-openapi.json

This example produces a fully dereferenced dereferenced-openapi.json, where all local and remote $ref references are resolved into the file. This is the default behaviour.

Example: No Bundling

$ openapi-format openapi.json -o openapi.json --no-bundle

In this case, the resulting bundled-openapi.json will preserve all $ref references as they are in the original document.

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 convertTo usage

🏗 BETA NOTICE: This feature is considered BETA since we are investigating the configuration syntax and extra formatting/casing capabilities.

• Format & convert the OpenAPI document to OpenAPI version 3.1

openapi-format can help you to upgrade your current OpenAPI 3.0.x document to the latest version OpenAPI 3.1.

$ openapi-format openapi.json -o openapi-3.1.json --convertTo "3.1"

which results in all the changes described in the migration guide from Phil Sturgeon

before

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

after

{
    "openapi": "3.1.0",
    "info": {
        "title": "OpenAPI Petstore - OpenAPI",

CLI configuration usage

The openapi-format CLI supports bundling all options in a single configuration file. This can simplify management, especially for CI/CD pipelines where configurations are stored in version control systems.

Using the --configFile option

You can pass a configuration file containing all the options that would otherwise be passed via the CLI. This helps in centralizing the configuration for your OpenAPI formatting operations.

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.

The openapi-format-options.json file might look like this:

{
  "sort": true,
  "casingSet": {
    "operationId": "camelCase",
    "properties": "snake_case"
  },
  "filterSet": {
    "tags": ["internal", "beta"]
  },
  "generateSet": {
    "operationIdTemplate": "<method>_<pathPart2>_Handler"
  }
}

Alternatively, you can reference external files for each setting using the corresponding File properties.

{
    "sortFile": "customSort.json",
    "casingFile": "casing-rules.json",
    "filterFile": "filter-rules.json",
    "generateFile": "generate-rules.json"
}

In this case, the settings will be loaded from the external files, and they override any inline configurations.

Define sort, filter, casing, generate options

You can either pass the settings inline or reference an external file using the appropriate File property:

• sortSet / sortFile: Sort the fields in the OpenAPI document based on the order defined in the sort settings.

  • Inline: Pass the sort order directly using sortSet in the config file.
  • File: Use sortFile to specify the path to a local or remote JSON/YAML file containing custom sorting rules.

• casingSet / casingFile: Define the casing convention for operationId, parameters, properties, etc.

  • Inline:

    "casingSet": {
      "operationId": "camelCase",
      "properties": "PascalCase"
    }

  • File: Use casingFile to specify the path to a local or remote JSON/YAML file containing casing rules.

• filterSet / filterFile: Filter out specific tags, paths, or components from the OpenAPI document.

  • Inline:

    "filterSet": {
      "tags": ["internal", "beta"]
    }

  • File: Use filterFile to specify the path to a local or remote JSON/YAML file containing filter rules.

• generateSet / generateFile: Automatically generate operationId, summary, and other elements based on predefined templates.

  • Inline:

    "generateSet": {
      "operationIdTemplate": "<method>_<pathPart2>_Handler"
    }

  • File: Use generateFile to specify the path to a local or remote JSON/YAML file containing generate rules.

Using .openapiformatrc

In addition to specifying a configuration file using --configFile, openapi-format also supports automatically loading a configuration file named .openapiformatrc from the current directory. If this file is present, it will be used as the configuration source, and individual options passed via the CLI will override the settings from this file.

Example of a .openapiformatrc file:

{
  "output": "openapi-final.yaml",  
  "sort": true,
  "filterSet": {
      "tags": ["internal", "beta"]
  }
}

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 lowered, 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 being 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 grounded by the work from @MikeRalphson on the openapi-filter package.

The casing options available in openapi-format are powered by the excellent case-anything nano package from Luca Ban (@mesqueeb).

Special thanks to JetBrains for their continuous sponsorship of this project over the last 3 years, and for their support to open-source software (OSS) initiatives.