{"id":13429469,"url":"https://github.com/dotnet/aspnet-api-versioning","last_synced_at":"2025-05-13T16:04:52.333Z","repository":{"id":37234983,"uuid":"64226740","full_name":"dotnet/aspnet-api-versioning","owner":"dotnet","description":"Provides a set of libraries which add service API versioning to ASP.NET Web API, OData with ASP.NET Web API, and ASP.NET Core.","archived":false,"fork":false,"pushed_at":"2025-04-12T21:21:32.000Z","size":3813,"stargazers_count":3120,"open_issues_count":30,"forks_count":709,"subscribers_count":110,"default_branch":"main","last_synced_at":"2025-04-22T11:37:11.274Z","etag":null,"topics":["aspnet","aspnetcore","odata","versioning","versioning-semantics","webapi"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dotnet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-07-26T14:13:32.000Z","updated_at":"2025-04-21T21:47:58.000Z","dependencies_parsed_at":"2023-02-17T07:45:51.571Z","dependency_job_id":"729825d3-6b6d-42a3-9aa2-1cab717b811c","html_url":"https://github.com/dotnet/aspnet-api-versioning","commit_stats":{"total_commits":298,"total_committers":6,"mean_commits":"49.666666666666664","dds":0.09060402684563762,"last_synced_commit":"3fc071913dcded23eeb5ebe55bca44f3828488bf"},"previous_names":["microsoft/aspnet-api-versioning"],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2Faspnet-api-versioning","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2Faspnet-api-versioning/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2Faspnet-api-versioning/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnet%2Faspnet-api-versioning/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dotnet","download_url":"https://codeload.github.com/dotnet/aspnet-api-versioning/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252590521,"owners_count":21772934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aspnet","aspnetcore","odata","versioning","versioning-semantics","webapi"],"created_at":"2024-07-31T02:00:40.056Z","updated_at":"2025-05-05T22:48:30.081Z","avatar_url":"https://github.com/dotnet.png","language":"C#","readme":"[![.NET Foundation](https://img.shields.io/badge/.NET%20Foundation-blueviolet.svg)](https://dotnetfoundation.org/projects/aspnet-api-versioning)\n[![MIT License](https://img.shields.io/github/license/dotnet/aspnet-api-versioning?color=%230b0\u0026style=flat-square)](https://github.com/dotnet/aspnet-api-versioning/blob/main/LICENSE.txt)\n[![Build Status](https://dev.azure.com/aspnet-api-versioning/build/_apis/build/status/dotnet.aspnet-api-versioning?branchName=main)](https://dev.azure.com/aspnet-api-versioning/build/_build/latest?definitionId=1\u0026branchName=main)\n\n# ASP.NET API Versioning\n\n| :mega: Check out the [announcement](../../discussions/807) regarding upcoming changes |\n|-|\n\n\u003cimg align=\"right\" width=\"100px\" src=\"logo.svg\" /\u003e\n\nThe _\"Asp\"_ project, more formally known as ASP.NET API Versioning, gives you a powerful, but easy-to-use method for\nadding API versioning semantics to your new and existing REST services built with ASP.NET. The API versioning extensions\ndefine simple metadata attributes and conventions that you use to describe which API versions are implemented by your\nservices. You don't need to learn any new routing concepts or change the way you implement your services in ASP.NET today.\n\nThe default API versioning configuration is compliant with the\n[versioning semantics](https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#12-versioning)\noutlined by the [Microsoft REST Guidelines](https://github.com/Microsoft/api-guidelines). There are also a number\nof customization and extension points available to support transitioning services that may not have supported API\nversioning in the past or supported API versioning with semantics that are different from the\n[Microsoft REST versioning guidelines](https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#12-versioning).\n\nThe supported flavors of ASP.NET are:\n\n* **ASP.NET Core**\n  \u003cdiv\u003eAdds API versioning to your ASP.NET Core \u003ci\u003eMinimal API\u003c/i\u003e applications\u003c/div\u003e\n\n  [![NuGet Package](https://img.shields.io/nuget/v/Asp.Versioning.Http.svg)](https://www.nuget.org/packages/Asp.Versioning.Http)\n  [![NuGet Downloads](https://img.shields.io/nuget/dt/Asp.Versioning.Http.svg?color=green)](https://www.nuget.org/packages/Asp.Versioning.Http)\n  [![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/New-Services-Quick-Start#aspnet-core)\n  [![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/main/examples/AspNetCore/WebApi)\n\n* **ASP.NET Core MVC**\n  \u003cdiv\u003eAdds API versioning to your ASP.NET Core MVC (Core) applications\u003c/div\u003e\n\n  [![NuGet Package](https://img.shields.io/nuget/v/Asp.Versioning.Mvc.svg)](https://www.nuget.org/packages/Asp.Versioning.Mvc)\n  [![NuGet Downloads](https://img.shields.io/nuget/dt/Asp.Versioning.Mvc.svg?color=green)](https://www.nuget.org/packages/Asp.Versioning.Mvc)\n  [![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/New-Services-Quick-Start#aspnet-core)\n  [![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/main/examples/AspNetCore/WebApi)\n\n* **ASP.NET Core and OData**\n  \u003cdiv\u003eAdds API versioning to your ASP.NET Core applications using OData v4.0\u003c/div\u003e\n\n  [![NuGet Package](https://img.shields.io/nuget/v/Asp.Versioning.OData.svg)](https://www.nuget.org/packages/Asp.Versioning.OData)\n  [![NuGet Downloads](https://img.shields.io/nuget/dt/Asp.Versioning.OData.svg?color=green)](https://www.nuget.org/packages/Asp.Versioning.OData)\n  [![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/New-Services-Quick-Start#aspnet-core-with-odata-v40)\n  [![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/main/examples/AspNetCore/OData)\n\n* **ASP.NET Web API**\n  \u003cdiv\u003eAdds API versioning to your Web API applications\u003c/div\u003e\n\n  [![NuGet Package](https://img.shields.io/nuget/v/Asp.Versioning.WebApi.svg)](https://www.nuget.org/packages/Asp.Versioning.WebApi)\n  [![NuGet Downloads](https://img.shields.io/nuget/dt/Asp.Versioning.WebApi.svg?color=green)](https://www.nuget.org/packages/Asp.Versioning.WebApi)\n  [![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/New-Services-Quick-Start#aspnet-web-api)\n  [![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/main/examples/AspNet/WebApi)\n\n* **ASP.NET Web API and OData**\n  \u003cdiv\u003eAdds API versioning to your Web API applications using OData v4.0\u003c/div\u003e\n\n  [![NuGet Package](https://img.shields.io/nuget/v/Asp.Versioning.WebApi.OData.svg)](https://www.nuget.org/packages/Asp.Versioning.WebApi.OData)\n  [![NuGet Downloads](https://img.shields.io/nuget/dt/Asp.Versioning.WebApi.OData.svg?color=green)](https://www.nuget.org/packages/Asp.Versioning.WebApi.OData)\n  [![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/New-Services-Quick-Start#aspnet-web-api-with-odata-v40)\n  [![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/main/examples/AspNet/OData)\n\nThis is also the home of the ASP.NET API versioning API explorers that you can use to easily document your REST APIs with OpenAPI:\n\n* **ASP.NET Core Versioned API Explorer**\n  \u003cdiv\u003eAdds additional API explorer support to your ASP.NET Core applications\u003c/div\u003e\n\n  [![NuGet Package](https://img.shields.io/nuget/v/Asp.Versioning.Mvc.ApiExplorer.svg)](https://www.nuget.org/packages/Asp.Versioning.Mvc.ApiExplorer)\n  [![NuGet Downloads](https://img.shields.io/nuget/dt/Asp.Versioning.Mvc.ApiExplorer.svg?color=green)](https://www.nuget.org/packages/Asp.Versioning.Mvc.ApiExplorer)\n  [![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/API-Documentation#aspnet-core)\n  [![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/main/examples/AspNetCore/WebApi/OpenApiSample)\n\n* **ASP.NET Core with OData API Explorer**\n  \u003cdiv\u003eAdds additional API explorer support to your ASP.NET Core applications using OData v4.0\u003c/div\u003e\n\n  [![NuGet Package](https://img.shields.io/nuget/v/Asp.Versioning.OData.ApiExplorer.svg)](https://www.nuget.org/packages/Asp.Versioning.OData.ApiExplorer)\n  [![NuGet Downloads](https://img.shields.io/nuget/dt/Asp.Versioning.OData.ApiExplorer.svg?color=green)](https://www.nuget.org/packages/Asp.Versioning.OData.ApiExplorer)\n  [![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/API-Documentation#aspnet-core-with-odata)\n  [![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/main/examples/AspNetCore/OData/OpenApiODataSample)\n\n* **ASP.NET Web API Versioned API Explorer**\n  \u003cdiv\u003eReplaces the default API explorer in your Web API applications\u003c/div\u003e\n\n  [![NuGet Package](https://img.shields.io/nuget/v/Asp.Versioning.WebApi.ApiExplorer.svg)](https://www.nuget.org/packages/Asp.Versioning.WebApi.ApiExplorer)\n  [![NuGet Downloads](https://img.shields.io/nuget/dt/Asp.Versioning.WebApi.ApiExplorer.svg?color=green)](https://www.nuget.org/packages/Asp.Versioning.WebApi.ApiExplorer)\n  [![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/API-Documentation#aspnet-web-api)\n  [![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/main/examples/AspNet/WebApi/OpenApiWebApiSample)\n\n* **ASP.NET Web API with OData API Explorer**\n  \u003cdiv\u003eAdds an API explorer to your Web API applications using OData v4.0\u003c/div\u003e\n\n  [![NuGet Package](https://img.shields.io/nuget/v/Asp.Versioning.WebApi.OData.ApiExplorer.svg)](https://www.nuget.org/packages/Asp.Versioning.WebApi.OData.ApiExplorer)\n  [![NuGet Downloads](https://img.shields.io/nuget/dt/Asp.Versioning.WebApi.OData.ApiExplorer.svg?color=green)](https://www.nuget.org/packages/Asp.Versioning.WebApi.OData.ApiExplorer)\n  [![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/API-Documentation#aspnet-web-api-with-odata)\n  [![Examples](https://img.shields.io/badge/example-code-2B91AF)](../../tree/main/examples/AspNet/OData/OpenApiODataWebApiSample)\n\nThe client-side libraries make it simple to create API version-aware HTTP clients.\n\n* **HTTP Client API Versioning Extensions**\n  \u003cdiv\u003eAdds API versioning support to HTTP clients\u003c/div\u003e\n\n  [![NuGet Package](https://img.shields.io/nuget/v/Asp.Versioning.Http.Client.svg)](https://www.nuget.org/packages/Asp.Versioning.Http.Client)\n  [![NuGet Downloads](https://img.shields.io/nuget/dt/Asp.Versioning.Http.Client.svg?color=green)](https://www.nuget.org/packages/Asp.Versioning.Http.Client)\n  [![Quick Start](https://img.shields.io/badge/quick-start-9B6CD1)](../../wiki/API-Documentation#http-client)\n\n## Documentation\n\nYou can find additional examples, documentation, and getting started instructions in the [wiki](../../wiki).\n\n## Discussion\n\nHave a general question, suggestion, or other feedback? Check out how you can [contribute](docs/CONTRIBUTING.md).\n\n## Code of Conduct\n\nThis project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.\nFor more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).\n\n## License\n\nThis project is licensed under the [MIT](LICENSE.TXT) license.\n\n## .NET Foundation\n\n[\u003cimg align=\"right\" width=\"100px\" style=\"margin:-70px 0px 0px 0px\" src=\"https://dotnetfoundation.org/img/logo_v4.svg\" /\u003e](https://dotnetfoundation.org/projects/aspnet-api-versioning)\nThis project is supported by the [.NET Foundation](https://dotnetfoundation.org).\n\n----\n\u003e If you are an existing user, please makes sure you review the [release notes](../../releases) between all major and minor package releases.\n\n\u003cdiv style=\"text-align:center;margin-top:32px;font-size:small\"\u003eLogo by \u003ca href=\"https://sacramento-design.com\" target=\"_blank\"\u003eSacramento Design Works\u003c/a\u003e\u003c/div\u003e\n","funding_links":[],"categories":["Frameworks, Libraries and Tools","aspnet","C#","C# #","Versioning","C\\#"],"sub_categories":["API"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotnet%2Faspnet-api-versioning","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdotnet%2Faspnet-api-versioning","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotnet%2Faspnet-api-versioning/lists"}