openapi-format
Advanced tools
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 and operationID's.
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.
The filtering is a handy add-on to remove specific elements from the OpenAPI like internal endpoints, beta tags, ... This can be useful in CI/CD pipelines, where the OpenAPI is used as source for other documents like Web documentation, Postman collections, test suites, ...
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.
$ npm install -g openapi-format
To execute the CLI without installing it via npm, use the npx method
$ npx openapi-format your-openapi-file.yaml
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 alfabehtically [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]
| 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 |
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 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 |
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 really 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'] |
Some more details on the available filter types:
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
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
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
This will remove specific path items that matches 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 are even possible.
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
$ openapi-format openapi.json -o openapi-formatted.json
$ openapi-format openapi.json -o openapi.yaml
$ openapi-format openapi.json --json
$ openapi-format openapi.json --yaml
$ openapi-format openapi.json -o openapi.yaml
$ 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.
$ 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.
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
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
{
"openapi": "3.0.2",
"info": {
"title": "Petstore - OpenAPI 3.0",
{
"openapi": "3.0.2",
"info": {
"title": "OpenAPI Petstore - OpenAPI 3.0",
All the CLI options can be managed in 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.
For handling AsyncAPI documents, we have created a separate package asyncapi-format to allow customisation specific for AsyncAPI use-cases.
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 to 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.
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.
[1.2.5] - 2021-07-22
FAQs
Format an OpenAPI document by ordering, formatting and filtering fields.
The npm package openapi-format receives a total of 21,416 weekly downloads. As such, openapi-format popularity was classified as popular.
We found that openapi-format demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.