AddApiVersionParser Method

Definition

Namespace

Codebelt.Extensions.Asp.Versioning

Assemblies

Codebelt.Extensions.Asp.Versioning.dll

Source

src/Codebelt.Extensions.Asp.Versioning/ServiceCollectionExtensions.cs

AddApiVersionParser<T>(IServiceCollection, T)

Adds the specified API version parser as the singleton parser used by API versioning services.

public static IServiceCollection AddApiVersionParser<T>(this IServiceCollection services, T parser) where T : IApiVersionParser

Parameters

services IServiceCollection

The IServiceCollection to extend.

parser T

The parser instance that should resolve API version values for the application.

Returns

IServiceCollection

A reference to services so that additional calls can be chained.

Type Parameters

T

The concrete Asp.Versioning.IApiVersionParser type to register.

Remarks

Register a custom parser when the application accepts version formats that differ from the default parser, such as semantic version aliases or compatibility tokens. The supplied parser is registered as the Asp.Versioning.IApiVersionParser singleton.

Exceptions

ArgumentNullException

services or parser is null.