How to validate openapi 3.0.0 yaml spec?

4
votes

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.

2
yamlswaggeropenapi

2 Answers

7
votes

Swagger Editor

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.

Other validators

https://openapi.tools has a list of OpenAPI validation tools, including command-line tools and Node.js modules.

1
votes

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.