Azure REST API Specifications
This repository is the canonical source for REST API specifications for Microsoft Azure.
In the Azure Developer Experience workflow, you are at Step 3:
If you're a spec author looking for information about all of of the repositories and steps in the pipeline, go back to the adx-documentation-pr repository. Make sure to join the Github Azure organization to get access to that repo.
- Our Contribution guidelines walks you through the process of contributing to this repository.
- The /documentation folder contains reference documentation for all aspects of Swagger and our recommended patterns. Start with the Creating Swagger page.
- If you are using Swashbuckle to generate a swagger spec from your .NET WEB API then please take a look at this repo.
The structure of the directory should strictly follow these rules:
- The top level folder must be the service name
- The second level must be the API versions
- The third level must be the format of the specification
- The fourth level must be the specifications
The structure should appear like so:
. ├── arm-authorization │ └── 2015-01-01 │ └── swagger │ └── authorization.json ├── arm-compute │ └── 2015-06-15 │ └── swagger │ └── service.json ├── arm-features │ └── 2014-08-01-preview │ └── swagger │ └── features.json ├── arm-network │ └── 2015-05-01-preview │ └── swagger │ └── service.json ├── arm-resources │ └── 2014-04-01-preview │ └── swagger │ └── service.json ├── arm-storage │ └── 2015-05-01-preview │ └── swagger │ └── service.json ├── arm-subscriptions │ └── 2014-04-01-preview │ └── swagger │ └── service.json ├── arm-web ├── documentation └── readme.md
Currently, the specifications are expected to be in Swagger JSON format
The next step in the process after a spec is completed is to generate SDKs. Go to the SDKs section of the Azure Developer Experience guide for more information.