Class ApiVersioningExtensions

Namespace

MADE.Web.Extensions

Assembly

MADE.Web.dll

Defines a collection of extensions for API versioning.

public static class ApiVersioningExtensions

Inheritance

object

ApiVersioningExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddApiVersionHeaderSupport(IServiceCollection, string, int, int)

Adds request header API versioning for controllers and APIs to the specified services collection.

public static IServiceCollection AddApiVersionHeaderSupport(this IServiceCollection services, string apiHeaderName = "x-api-version", int defaultMajor = 1, int defaultMinor = 0)

Parameters

services IServiceCollection

The services available in the application.

apiHeaderName string

The name of the header that is required when making requests to API endpoints. Default, x-api-version.

defaultMajor int

The default major version of the API. Default, 1.

defaultMinor int

The default minor version of the API. Default, 0.

Returns

IServiceCollection

The configured services object.

AddApiVersionSupport(IServiceCollection, int, int)

Adds request API versioning for controllers and APIs to the specified services collection.

public static IServiceCollection AddApiVersionSupport(this IServiceCollection services, int defaultMajor = 1, int defaultMinor = 0)

Parameters

services IServiceCollection

The services available in the application.

defaultMajor int

The default major version of the API. Default, 1.

defaultMinor int

The default minor version of the API. Default, 0.

Returns

IServiceCollection

The configured services object.