Validate API

OpenAPI files can be validated with the CLI tooling. This is useful to ensure that downstream systems remain functional after the OpenAPI specification has been updated.

For a full overview of validation checks: see the validate-api overview page

Using Vaktum CLI to validate OpenAPI files

To validate an OpenAPI file simply call the command below. <openapi.json> is the path to the OpenAPI file you want to validate in json or yaml format

vaktum validate <openapi.json>

Any validation issues will be listed in the output of the program. In case there are validation issues the cli program will return an error on exit which in turn fails most CI/CD pipelines.