I have a yaml specification that has been updated from swagger 2.0 to openapi 3.0.0
The file itself is about 7,000 lines so it is challenging to validate by hand.
I need to figure out which tags I have are no longer compatible with openapi 3.0.0. How can I validate my schema? Are there any command line tools I can use?
I do not want to copy/paste this code somewhere online because I don't want to expose all the routes publicly.
https://editor.swagger.io performs validation on the client side, meaning your definition is not sent anywhere. You can also run the editor locally, e.g. offline.
Notes:
Because of lazy loading you may need to expand all operations and models in the UI panel to see all of the errors.
Warnings are displayed as gutter icons, apart from the error list.
https://openapi.tools has a list of OpenAPI validation tools, including command-line tools and Node.js modules.
Vacuum is a nice fast command line tool for openapi spec validation.
Once you have it installed, linting is as simple as:
$ vacuum lint -d my-openapi-specification.yaml
(-d means details - print out found issues)
Use openapi-lint extension on visual studio code and remember to name your file as *openapi.json, *openapi.yaml, *openapi.yml, *oas3.json, *oas3.yml, *oas3yaml.
I use swagger-cli. It's a validator and bundler that supports $ref among other things.
OpenAPI Generator CLI tool, which is widely used, also offers schema validation.
To validate a schema using Docker, you can run the following command:
docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli validate \
-i /local/file.yaml
Alternatively, you can use the shell script provided in the OpenAPI Generator repository: https://github.com/OpenAPITools/openapi-generator/blob/master/bin/utils/openapi-generator-cli.sh
./openapi-generator-cli.sh validate -i file.yaml
For more information on how to use OpenAPI Generator CLI, you can refer to the documentation at: https://openapi-generator.tech/docs/usage
