/NOW.ApiVersioning

API Versioning extensions

Primary LanguageC#MIT LicenseMIT

Api Versioning Banner

NOW API Versioning, is a set of extensions to simplify REST API versioning

Simplifies setup and configuration for API Version behavior with Microsoft.AspNetCore.Mvc.Versioning. The middleware provided combines path (URL), query-string and header version-readers. Additionally, a swagger package is provided, which contains extensions to add 'Versioned Swagger' and 'Versioned Swagger UI' documentation.

Build Status

Branch Status
master master

NuGet Packages

Package Name .NET 7
ApiVersioning Preview
ApiVersioning.Swagger Preview

Getting started

Clone the repository and run the included ApiTestApplication, the default start-page will be the swagger documentation page, where you can play around with the test controller/endpoint, in combination with Api Versioning.

Additionally, you can visit /allservices, to display all service registrations. This endpoint uses the package Ardalis.ListStartupServices.

Features

  • NOW.ApiVersioning
    Simplifies setup and configuration for API Version behavior with Microsoft.AspNetCore.Mvc.Versioning. The middleware provided combines path (URL), query-string and header version-readers. read more...

  • NOW.ApiVersioning.Swagger
    This package contains extensions to add a 'Versioned Swagger' and 'Versioned Swagger UI' documentation, using the NOW.FeatureFlagExtensions.ApiVersioning package. read more...

Community

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information, see the Code of Conduct.