Skip to content
Chris Martinez edited this page Dec 28, 2022 · 17 revisions

Versioning is an important aspect of any mature web service. Microsoft has published REST API guidelines that require that all compliant services must support explicit versioning. This ensures that clients can rely on services to be stable over time, while still enabling service changes and new features. The goal of the ASP.NET API Versioning project is to adhere to the Microsoft REST Guidelines for versioning using the ASP.NET technology stack out-of-the-box, but there are numerous extensions and customizations that allow you to version your APIs however you like. Detailed information about the recommended guidance can be found in the Microsoft REST Guidelines.

ASP.NET API Versioning supports the following variants of ASP.NET:

ASP.NET Web API

Everything you need to add service API versioning to your Web API applications and controller classes.

ASP.NET Web API and OData

Expands upon the service API versioning for Web API and adds OData-specific features for your OData v4.0 applications and OData controllers, including support for versioned Entity Data Models (EDMs).

ASP.NET Core

Everything you need to add service API versioning to your ASP.NET Core applications and Minimal APIs.

ASP.NET Core MVC (Core)

Expands upon the service API versioning for ASP.NET Core and adds support for controller classes.

ASP.NET Core and OData

Expands upon the service API versioning for ASP.NET Core and adds OData-specific features for your OData v4.0 applications and OData controllers, including support for versioned Entity Data Models (EDMs).

Clone this wiki locally