diff --git a/README.md b/README.md index 0efc3c778444..2abd616e466c 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ This repository is the canonical source for REST API specifications for Microsoft Azure. +## Creating the Swagger Specification for Azure +- This [document](./documentation/creating-swagger.md) will help you understand how AutoRest converts Swagger in to code. +- If you are using swashbuckle to generate a swagger spec from your .NET WEB API then please take a look at this [repo]( https://github.com/Azure/swashbuckle-resource-provider). + ## Directory Structure The structure of the directory should strictly follow these rules: @@ -48,10 +52,7 @@ The structure should appear like so: └── readme.md ``` -At this point, the specifications are expected to be in swagger format. - -## Creating the Swagger Specification for Azure -This [document](./documentation/creating-swagger.md) will help you understand how AutoRest converts Swagger in to code. +At this point, the specifications are expected to be in swagger format ## How to validate your swagger * [You can use this json schema validator](https://json-schema-validator.herokuapp.com/)