`oas-toolkit` is a library and CLI for working with OpenAPI documents.
npm install oas-toolkitoas-toolkit is a library and CLI for working with OpenAPI documents.
> The CLI only supports YAML OpenAPI specifications currently
The project provides the following functionality:
- Merge multiple OAS documents into a single file
- Add/patch values in place
- Remove arbitrary keys from the specification
- Remove unused components
Usage:
``bash`
oas-toolkit merge
Combining multiple OpenAPI specs has unspecified behaviour. This tool merges using the following algorithm:
Take the latest specified value for the following blocks:
- openapi
- info
- servers
- externalDocs
Merge the following lists/objects recursively. If you encounter a list, concatenate them together:
- security
- tags
- components
- paths
`bash`
oas-toolkit remove-with-annotation --annotation x-visibility.internal=true /tmp/openapi.yaml
Remove paths or operations from an OpenAPI spec based on an annotation. The example provided will remove any paths or operations with the following annotation:
`json`
{
"x-visibility": {
"internal": true
}
}
You can pass --remove-unused to run remove-unused-components and remove-tags` after running this command.