Validation for Open API definition files

WebSphere Developer Tools provide some validation support for REST API definition files. This validation is based on the Open API 3.0 specification or the Open API 2.0 (Swagger 2.0) specification.

The validation based on Open API 3.0 provides validation for any Open API 3.0 definitions that have the recommended file name convention of openapi.json or any other JSON file with the "openapi":"3.0.0" pair as the initial name and value pair in the file. Name the file openapi.json and place it in the META-INF folder of the web module. If you choose to use a YAML file, name the file openapi.yaml.

For validation based on Open API 2.0, the files must be named swagger.json. The tools do not support version 2.0 validation for files with other names, including *.json files. Support is limited, and it does not include all aspects of the Open API 2.0 validation support specification. For Open API 2.0, place only swagger.json or swagger.yaml files in the META-INF folder.

If the openapi.json file or the swagger.json file contains errors, then the Problems view can display some error messages specific to the Open API Specification. The Markers view also displays error messages specific to Open API. Click Window > Show View > Markers to see the Markers view.