NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
NuGet, #360 most downloaded on NuGet
ASP.NET Core MVC API explorer functionality for discovering metadata such as the list of API-versioned controllers and actions, and their URLs and allowed HTTP methods.
Latest stable
5.1.0
Last release 4 years ago
no release in 18 months
Ships unpredictably
gaps range from 3 weeks to 2.3 years
Most releases are documented
notes for 13 of 16 stable releases
Nothing withdrawn
no release was ever pulled
10 years old
21 releases · first in 2017
Drag across the ruler to compare, or tap a release to open it.
Fix deprecated API version aggregation
This represents the official release for ASP.NET Core with support for .NET 5.0 and .NET 6.0.
:mega: Aside from servicing,
5.1.xmarks the end of the packages and naming under theMicrosoft.AspNet*prefixes. For more background, see the announcement and roadmap. Despite months of communicate with Microsoft and the .NET Foundation to re-enable publishing permissions for the NuGet packages, I'm still unable to. At this point, I suspect it may never happen and this release contains the official, signed packages which you can integrate into your own NuGet feeds.
This release has been a long time coming, but has been stymied due to administrative changes in moving the project under the .NET Foundation. Now that the process is complete, you can expect fluid releases once more. The following highlights high-level changes since 5.0.0. For the complete list, please review the change log.
No significant new features in this release
LockRecursionException (#703)[FromODataUri] (#693, #729, #737)PostTo navigation properties (#742)all function (#758)IApiVersioningFeature (#704)IApiVersioningFeature on pipeline reentry (#748, #749)Allow for 405 to actions in the same API version (#795)[FromODataUri] (#693, #729, #737)PostTo navigation properties (#742)IEdmModelSelector leverages IApiVersionSelector (#745)all function (#758)IControllerNameConvention (#734)IUrlFactory implementation (#720)No known breaking changes
6.0 support for OData has been rebuilt from the ground up and supports 8.x along with .NET Core 3.1 and .NET 6.0Big thank you to the community for contributing:
Your coding agent can read these notes before it upgrades. Set up the MCP server →
This represents the official release for ASP.NET Core with support for .NET 5.0.
This represents the official release for ASP.NET Core with support for .NET 5.0.
No new features in this release
No significant fixes in this release
A few enhancements were completed in this release:
No known breaking changes
Big thank you to the community for contributing:
OData 8.0 is not supported and will not be supported 5.0.0; there are breaking changes introduced by OData which will require another major version ch…
This marks the official release of 4.2.0 across the board. Each package version has drifted over time and this release was unable to align all the version numbers again.
For clarity, these are the package version numbers in this release:
| Package ID | Package Version |
|---|---|
| Microsoft.AspNet.OData.Versioning | 5.0.0 |
| Microsoft.AspNet.OData.Versioning.ApiExplorer | 5.0.0 |
| Microsoft.AspNet.WebApi.Versioning | 4.1.0 |
| Microsoft.AspNet.WebApi.Versioning.ApiExplorer | 4.1.0 |
| Microsoft.AspNetCore.Mvc.Versioning | 4.2.0 |
| Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer | 4.2.0 |
| Microsoft.AspNetCore.OData.Versioning | 5.0.0 |
| Microsoft.AspNetCore.OData.Versioning.ApiExplorer | 5.0.0 |
There are no additional changes, fixes, or features from the OData 5.0.0 RC 2 release. The release notes from OData 5.0.0 RC 1 and 2 contain the full rollup of release notes to this point.
Drop support for .NET Core 2.2
Drop support for .NET Core 2.2
Add support for .NET Core 3.1
Add support for .NET Core 3.1
4.1.0 is a small release with no functional changes. The key change is targeting .NET Core 3.1 for all flavors of ASP.NET Core, specifically OData, and dropping support for ASP.NET Core 2.2.
Refactor conventions API; interfaces are defined end-to-end (see _Breaking Changes_)
This marks the official release of 4.0. All of the prerelease and previous version features, as well as any fixes, roll up into this release.
The following are new features and/or enhancements since 3.1.0:
$ref (#494)$ref (#494)The following are fixes and patches since 3.1.0:
There are no additional breaking changes since the preview release. Review the preview release for additional details.
The following are known issues in this release:
services.AddMvc( options => options.EnableEndpointRouting = false );Special thanks to the support and contributions from the community:
Update Authenticode signature to use SHA256
Update Authenticode signature to use SHA256
Added ApiDescription IsDeprecated extension method
Added ApiDescription IsDeprecated extension method
Support exploring default parameters values
Support exploring default parameters values (#414)
This is a minor release that primarily supports the Endpoint Routing feature introduced in ASP.NET Core 2.2.
This release will require you to upgrade to ASP.NET Core 2.2 if you haven't already
The following are new features since 3.0.0:
[ApiController]interface IApiControllerSpecification
{
bool IsSatisfiedBy( ControllerModel controller );
}
The following are fixes and patches since 3.0.0:
POST when the controller action is not an EDM actionPOST when the controller action is not an EDM actionThe following a behavioral breaking changes.
ApiVersioningOptions.UseApiBehavior is now true by default
[ApiController] has not been applied[ApiController] cannot be appliedApiVersioningOptions.UseApiBehavior = false[ApiController]services.TryAddEnumerable(ServiceDescriptor.Transient<IApiControllerSpecification, MyApiControllerSpec>());public class MyApiControllerSpec : IApiControllerSpecification
{
// consider all controllers that inherit from Controller to be a UI controller
readonly Type UIControllerType = typeof( Controller ).GetTypeInfo();
public bool IsSatisfiedBy( ControllerModel controller ) =>
!UIControllerType.IsAssignableFrom( controller.ControllerType )
}
Figure 1: Sample custom API specification
The following are known issues in this release:
services.AddMvc( options => options.EnableEndpointRouting = false );Update Authenticode signature to use SHA256
Update Authenticode signature to use SHA256
This marks the official release of 3.0. All of the Beta features and fixes roll up into this release. The delta from Beta 2 is primarily fixes and enh
This marks the official release of 3.0. All of the Beta features and fixes roll up into this release. The delta from Beta 2 is primarily fixes and enhancements.
The following are new features since 3.0.0 Beta 2:
The following are fixes and patches since 3.0.0 Beta 2:
[ApiExplorerSettings(IgnoreApi = false)] (#405)If you have cloned or forked this repository, the setups in the acceptance test suite have been refactored to maximize test server reuse. You can expect a 5-10x performance improvement in overall test run times.
The future roadmap currently only includes minor updates for ASP.NET Core. The 3.1 release will include support for the new Endpoint Routing feature in ASP.NET Core 2.2. For the first time, API Versioning will require the minimum version of ASP.NET Core to be 2.2 or above. The legacy method of routing will continue to be supported, but Endpoint Routing will be the new default and preferred method of routing.
Breaking changes are always carefully considered. In designing some of the new features, it became clear that a few breaking changes were required. Gi…
The Beta 2 release marks a key milestone, which includes an array of fixes as well as new features you've been asking for. This release is expected to mark 3.0 as feature complete. Any further changes from now to the official release are only expected to include additional bug fixes or performance enhancements.
The following are new features or enhancements since 3.0.0 Beta 1:
The following are fixes and patches since 3.0.0 Beta 1:
IsApiVersionNeutral() convention does not make an API version-neutral (#322)Breaking changes are always carefully considered. In designing some of the new features, it became clear that a few breaking changes were required. Given 3.0 is a major release, now was the appropriate time to introduce these changes. For most users, the changes will be transparent. The differences are most visible to those that are using the customization and extension features.
The following are breaking changes since 2.3.0 and 3.0.0 Beta 1:
The IApiVersionProvider now has the signature:
public interface IApiVersionProvider
{
ApiVersionProviderOptions Options { get; }
IReadOnlyList<ApiVersion> Versions { get; }
}
Where the options are:
[Flags]
public enum ApiVersionProviderOptions
{
None,
Deprecated = 1,
Advertised = 2,
Mapped = 4,
}
The new Mapped option disambiguates a declared API version from an API version mapped to a declaration.
The new MappingTo(ApiVersion) extension method determines whether an API is mapped and if it is explicit or implicit. The IsMappedTo(ApiVersion) extension method is now available on all platforms.
The ApiVersionModel constructors have been reduced to forms that have no dependencies or assumptions on collecting information from attributes.
GetApiVersionModel extension methodSpecial thanks to the support and contributions from the community:
The following are breaking changes since 2.3.0:
This the next major iteration of API versioning for all platforms. NuGet package distribution will begin with a Beta release will provide an opportunity to play with new features, provide feedback, and let things burn in before releasing for general availability.
The most significant new feature is support for the highly anticipated and demanded ASP.NET Core with OData implementation. It will take some time to update all of the documentation on the wiki, but in the meantime there are example projects that illustrate how to configure your application.
The following are new features or enhancements since 2.3.0:
IApiVersionConvention<T> (Issue #278)IControllerConvention (Issue #278)IControllerConventionBuilder (Issue #278)VersionByNamespaceConvention (Issue #278)IApiVersioningFeature (Issue #280)AddVersionedApiExplorer now calls the built-in AddApiExplorer implicitlyUseApiVersioning (advanced scenario to control middleware registration)ApiVersioningOptions.RegisterMiddleware option, which defaults to true
false can be paired with UseApiVersioning for advance middleware scenariosThe following are breaking changes since 2.3.0:
ApiVersionConventionBuilder.ControllerConventions is now ApiVersionConventionBuilder.ControllerConventionBuilders
ApiVersionConventionBuilder.ControllerConventions now refers to a collection of the new IControllerConvention interfaceApiVersionRequestProperties.RawApiVersion was renamed to ApiVersionRequestProperties.RawRequestedApiVersion (for parity with ASP.NET Core feature)ApiVersionRequestProperties.ApiVersion was renamed to ApiVersionRequestProperties.RequestedApiVersion (for parity with ASP.NET Core feature)System.Web.OData namespace were updated to Microsoft.AspNet.OData (also has parity with OData 7.0 and ASP.NET Core)VersionedODataModelBuilder.ModelBuilderFactory now uses new ODataConventionModelBuilder().EnableLowerCamelCase() by defaultAddVersionedApiExplorer is now a IServiceCollection extension method instead of a IMvcCoreBuilder extension methodAddApiVersioning no longer implicitly calls AddMvcCore (it doesn't have an actual dependency on it)IApiVersionRoutePolicy no longer implements IRouter; the old RouteAsync method is now Evaluate(RouteContext, ActionSelectionResult)ApiVersionConvention has been removed and replaced by ApiVersionCollator (Issue #301)Nothing published for this version
Nothing published for this version
This is another minor release with respect to changes, but includes the much anticipated and highly demanded support for ASP.NET Core 2.0. There are n
This is another minor release with respect to changes, but includes the much anticipated and highly demanded support for ASP.NET Core 2.0. There are no visible API or behavioral changes in this release.
The following are fixes addressed in the current release:
The following are new or updated features in the current release:
Nothing published for this version
Nothing published for this version
API versions can be expressed using conventions
Refactored support for the api-supported-versions and api-deprecated-versions HTTP headers to return in the multi-value format using a comma-separated…
This release represents the last anticipated set of features and API changes. This release includes a few minor changes, a couple of bug fixes, and a couple of new examples.
Nothing published for this version
One column per quarter.