Skip to content

Latest commit

 

History

History
39 lines (18 loc) · 1.21 KB

SwaggerValidationTools.md

File metadata and controls

39 lines (18 loc) · 1.21 KB
Raw

There are some tools that can help you make sure your specifications conform to the accepted guidelines. Better upfront validation before the final pull request is sent will result in quicker turnaround time.

Validation tools available locally

The various tools mentioned above are also available for local download.

  • Install Node.js (7.10.0 or greater)

Linter Validator:

 - `npm install -g autorest`
 -  `autoRest <path to readme.md> --azure-validator=true`

Static Validator (Semantic):

 - `npm install -g oav`
 - `bash-3.2$ oav validate-spec <spec-path>`

Static Validator (Model):

 - `npm install -g oav`
 - `bash-3.2$ oav validate-example <spec-path>`

Swagger diff tool

 - `npm install -g [email protected]`
 - `bash-3.2$ oad compare <old-spec> <new-spec>`

I don't agree with the reported errors, how do I suppress them? (for MS FTEs)

If you believe that the errors reported are false positives or don't apply for your specs, you might consider reviewing the validation errors suppression process and request suppression of these errors.