Skip to content

Commit 7eb13c4

Browse files
Shiny new README
1 parent 7750aa6 commit 7eb13c4

File tree

1 file changed

+70
-45
lines changed

1 file changed

+70
-45
lines changed

README.md

Lines changed: 70 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,88 @@
1+
[![.NET Foundation](https://img.shields.io/badge/.NET%20Foundation-blueviolet.svg)](https://dotnetfoundation.org/projects/aspnet-api-versioning)
2+
[![MIT License](https://img.shields.io/github/license/dotnet/aspnet-api-versioning?color=%230b0&style=flat-square)](https://github.com/dotnet/aspnet-api-versioning/blob/main/LICENSE.txt)
3+
14
| :mega: Check out the [announcement](../../discussions/807) regarding upcoming changes |
25
|-|
36

47
# ASP.NET API Versioning
58

9+
<style>
10+
div.bullet {
11+
margin:-8px 0px 8px 0px
12+
}
13+
</style>
14+
615
ASP.NET API versioning gives you a powerful, but easy-to-use method for adding API versioning semantics to your new and existing REST services built with ASP.NET. The API versioning extensions define simple metadata attributes and conventions that you use to describe which API versions are implemented by your services. You don't need to learn any new routing concepts or change the way you implement your services in ASP.NET today.
716

817
The default API versioning configuration is compliant with the [versioning semantics](https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#12-versioning) outlined by the [Microsoft REST Guidelines](https://github.com/Microsoft/api-guidelines). There are also a number of customization and extension points available to support transitioning services that may not have supported API versioning in the past or supported API versioning with semantics that are different from the [Microsoft REST versioning guidelines](https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#12-versioning).
918

1019
The supported flavors of ASP.NET are:
1120

12-
* **ASP.NET Web API** (
13-
[nuget](https://www.nuget.org/packages/Microsoft.AspNet.WebApi.Versioning) |
14-
[quick start](../../wiki/New-Services-Quick-Start#aspnet-web-api) |
15-
[samples](../../tree/master/samples/webapi) )
16-
<br>Adds service API versioning to your Web API applications<br>
17-
18-
* **ASP.NET Web API and OData** (
19-
[nuget](https://www.nuget.org/packages/Microsoft.AspNet.OData.Versioning) |
20-
[quick start](../../wiki/New-Services-Quick-Start#aspnet-web-api-with-odata-v40) |
21-
[samples](../../tree/master/samples/webapi) )
22-
<br>Adds service API versioning to your Web API applications using OData v4.0<br>
23-
24-
* **ASP.NET Core** (
25-
[nuget](https://www.nuget.org/packages/Microsoft.AspNetCore.Mvc.Versioning) |
26-
[quick start](../../wiki/New-Services-Quick-Start#aspnet-core) |
27-
[samples](../../tree/master/samples/aspnetcore) )
28-
<br>Adds service API versioning to your ASP.NET Core applications<br>
21+
* **ASP.NET Web API**
22+
<div class="bullet">Adds service API versioning to your Web API applications</div>
23+
24+
[![NuGet Package](https://img.shields.io/nuget/v/Microsoft.AspNet.WebApi.Versioning.svg)](https://www.nuget.org/packages/Microsoft.AspNet.WebApi.Versioning)
25+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Microsoft.AspNet.WebApi.Versioning.svg?color=green)](https://www.nuget.org/packages/Microsoft.AspNet.WebApi.Versioning)
26+
[![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/New-Services-Quick-Start#aspnet-web-api)
27+
[![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/master/samples/webapi)
28+
29+
* **ASP.NET Web API and OData**
30+
<div class="bullet">Adds service API versioning to your Web API applications using OData v4.0</div>
31+
32+
[![NuGet Package](https://img.shields.io/nuget/v/Microsoft.AspNet.OData.Versioning.svg)](https://www.nuget.org/packages/Microsoft.AspNet.OData.Versioning)
33+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Microsoft.AspNet.OData.Versioning.svg?color=green)](https://www.nuget.org/packages/Microsoft.AspNet.OData.Versioning)
34+
[![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/New-Services-Quick-Start#aspnet-web-api-with-odata-v40)
35+
[![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/master/samples/webapi)
36+
37+
* **ASP.NET Core**
38+
<div class="bullet">Adds service API versioning to your ASP.NET Core applications</div>
39+
40+
[![NuGet Package](https://img.shields.io/nuget/v/Microsoft.AspNetCore.Mvc.Versioning.svg)](https://www.nuget.org/packages/Microsoft.AspNetCore.Mvc.Versioning)
41+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Microsoft.AspNetCore.Mvc.Versioning.svg?color=green)](https://www.nuget.org/packages/Microsoft.AspNetCore.Mvc.Versioning)
42+
[![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/New-Services-Quick-Start#aspnet-core)
43+
[![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/master/samples/aspnetcore)
2944

30-
* **ASP.NET Core and OData** (
31-
[nuget](https://www.nuget.org/packages/Microsoft.AspNetCore.OData.Versioning) |
32-
[quick start](../../wiki/New-Services-Quick-Start#aspnet-core-with-odata-v40) |
33-
[samples](../../tree/master/samples/aspnetcore) )
34-
<br>Adds service API versioning to your ASP.NET Core applications using OData v4.0
45+
* **ASP.NET Core and OData**
46+
<div class="bullet">Adds API versioning to your ASP.NET Core applications using OData v4.0</div>
47+
48+
[![NuGet Package](https://img.shields.io/nuget/v/Microsoft.AspNetCore.OData.Versioning.svg)](https://www.nuget.org/packages/Microsoft.AspNetCore.OData.Versioning)
49+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Microsoft.AspNetCore.OData.Versioning.svg?color=green)](https://www.nuget.org/packages/Microsoft.AspNetCore.OData.Versioning)
50+
[![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/New-Services-Quick-Start#aspnet-core-with-odata-v40)
51+
[![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/master/samples/aspnetcore)
3552

3653
This is also the home of the ASP.NET API versioning API explorers that you can use to easily document your REST APIs with Swagger:
3754

38-
* **ASP.NET Web API Versioned API Explorer** (
39-
[nuget](https://www.nuget.org/packages/Microsoft.AspNet.WebApi.Versioning.ApiExplorer) |
40-
[quick start](../../wiki/API-Documentation#aspnet-web-api) |
41-
[samples](../../tree/master/samples/webapi/SwaggerWebApiSample) )
42-
<br> Replaces the default API explorer in your Web API applications<br>
43-
44-
* **ASP.NET Web API with OData API Explorer** (
45-
[nuget](https://www.nuget.org/packages/Microsoft.AspNet.OData.Versioning.ApiExplorer) |
46-
[quick start](../../wiki/API-Documentation#aspnet-web-api-with-odata) |
47-
[samples](../../tree/master/samples/webapi/SwaggerODataWebApiSample) )
48-
<br>Adds an API explorer to your Web API applications using OData v4.0<br>
49-
50-
* **ASP.NET Core Versioned API Explorer** (
51-
[nuget](https://www.nuget.org/packages/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer) |
52-
[quick start](../../wiki/API-Documentation#aspnet-core) |
53-
[samples](../../tree/master/samples/aspnetcore/SwaggerSample) )
54-
<br>Adds additional API explorer support to your ASP.NET Core applications<br>
55-
56-
* **ASP.NET Core with OData API Explorer** (
57-
[nuget](https://www.nuget.org/packages/Microsoft.AspNetCore.OData.Versioning.ApiExplorer) |
58-
[quick start](../../wiki/API-Documentation#aspnet-core-with-odata) |
59-
[samples](../../tree/master/samples/aspnetcore/SwaggerODataSample) )
60-
<br>Adds additional API explorer support to your ASP.NET Core applications using OData v4.0
55+
* **ASP.NET Web API Versioned API Explorer**
56+
<div class="bullet">Replaces the default API explorer in your Web API applications</div>
57+
58+
[![NuGet Package](https://img.shields.io/nuget/v/Microsoft.AspNet.WebApi.Versioning.ApiExplorer.svg)](https://www.nuget.org/packages/Microsoft.AspNet.WebApi.Versioning.ApiExplorer)
59+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Microsoft.AspNet.WebApi.Versioning.ApiExplorer.svg?color=green)](https://www.nuget.org/packages/Microsoft.AspNet.WebApi.Versioning.ApiExplorer)
60+
[![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/API-Documentation#aspnet-web-api)
61+
[![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/master/samples/webapi/SwaggerWebApiSample)
62+
63+
* **ASP.NET Web API with OData API Explorer**
64+
<div class="bullet">Adds an API explorer to your Web API applications using OData v4.0</div>
65+
66+
[![NuGet Package](https://img.shields.io/nuget/v/Microsoft.AspNet.OData.Versioning.ApiExplorer.svg)](https://www.nuget.org/packages/Microsoft.AspNet.OData.Versioning.ApiExplorer)
67+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Microsoft.AspNet.OData.Versioning.ApiExplorer.svg?color=green)](https://www.nuget.org/packages/Microsoft.AspNet.OData.Versioning.ApiExplorer)
68+
[![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/API-Documentation#aspnet-web-api-with-odata)
69+
[![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/master/samples/webapi/SwaggerODataWebApiSample)
70+
71+
* **ASP.NET Core Versioned API Explorer**
72+
<div class="bullet">Adds additional API explorer support to your ASP.NET Core applications</div>
73+
74+
[![NuGet Package](https://img.shields.io/nuget/v/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer.svg)](https://www.nuget.org/packages/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer)
75+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer.svg?color=green)](https://www.nuget.org/packages/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer)
76+
[![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/API-Documentation#aspnet-core)
77+
[![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/master/samples/aspnetcore/SwaggerSample)
78+
79+
* **ASP.NET Core with OData API Explorer**
80+
<div class="bullet">Adds additional API explorer support to your ASP.NET Core applications using OData v4.0</div>
81+
82+
[![NuGet Package](https://img.shields.io/nuget/v/Microsoft.AspNetCore.OData.Versioning.ApiExplorer.svg)](https://www.nuget.org/packages/Microsoft.AspNetCore.OData.Versioning.ApiExplorer)
83+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Microsoft.AspNetCore.OData.Versioning.ApiExplorer.svg?color=green)](https://www.nuget.org/packages/Microsoft.AspNetCore.OData.Versioning.ApiExplorer)
84+
[![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/API-Documentation#aspnet-core-with-odata)
85+
[![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/master/samples/aspnetcore/SwaggerODataSample)
6186

6287
You can find additional samples, documentation, and getting started instructions in the [wiki](../../wiki).
6388

0 commit comments

Comments
 (0)