ApiVersionAliasParser Constructor

Definition

Namespace

Codebelt.Extensions.Asp.Versioning

Assemblies

Codebelt.Extensions.Asp.Versioning.dll

Source

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

ApiVersionAliasParser(IReadOnlyDictionary<string, ApiVersion>)

Initializes a new instance of the ApiVersionAliasParser class that falls back to Asp.Versioning.ApiVersionParser.Default.

public ApiVersionAliasParser(IReadOnlyDictionary<string, ApiVersion> aliases)

Parameters

aliases IReadOnlyDictionary<string, ApiVersion>

The alias map to use before invoking the default parser.

Remarks

The dictionary key is the external version token accepted from a request, and the dictionary value is the canonical Asp.Versioning.ApiVersion returned for that token.

Exceptions

ArgumentNullException

aliases is null.

ArgumentException

aliases contains no entries.

ApiVersionAliasParser(IReadOnlyDictionary<string, ApiVersion>, IApiVersionParser)

Initializes a new instance of the ApiVersionAliasParser class with the specified alias map and fallback parser.

public ApiVersionAliasParser(IReadOnlyDictionary<string, ApiVersion> aliases, IApiVersionParser fallback)

Parameters

aliases IReadOnlyDictionary<string, ApiVersion>

The alias map to use before invoking fallback.

fallback IApiVersionParser

The parser to use when aliases does not contain the requested version token.

Remarks

The dictionary key is the external version token accepted from a request, and the dictionary value is the canonical Asp.Versioning.ApiVersion returned for that token. Alias lookup uses the comparer configured by the supplied aliases dictionary.

Exceptions

ArgumentNullException

aliases or fallback is null.

ArgumentException

aliases contains no entries.