Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amarzavery authored Jun 16, 2016
1 parent 5129caa commit 097cfe4
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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/)
Expand Down

0 comments on commit 097cfe4

Please sign in to comment.