CreateSemanticVersionAlias Method

Definition

Namespace

Codebelt.Extensions.Asp.Versioning

Assemblies

Codebelt.Extensions.Asp.Versioning.dll

Source

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

CreateSemanticVersionAlias(SemanticApiVersion)

Creates an API version parser that recognizes shortened aliases for a single semantic API version.

public static IApiVersionParser CreateSemanticVersionAlias(SemanticApiVersion version)

Parameters

version SemanticApiVersion

The semantic API version to expose through major, major-minor, and major-minor-patch aliases.

Returns

IApiVersionParser

An Asp.Versioning.IApiVersionParser that maps aliases such as 1, 1.2, and 1.2.3 to the specified version.

Remarks

The returned parser falls back to Asp.Versioning.ApiVersionParser.Default when a requested version is not one of the generated aliases.

CreateSemanticVersionAlias(IEnumerable<SemanticApiVersion>)

Creates an API version parser that recognizes shortened aliases for the specified semantic API versions.

public static IApiVersionParser CreateSemanticVersionAlias(IEnumerable<SemanticApiVersion> versions)

Parameters

versions IEnumerable<SemanticApiVersion>

The semantic API versions to expose through major, major-minor, and major-minor-patch aliases.

Returns

IApiVersionParser

An Asp.Versioning.IApiVersionParser that maps each generated alias to its corresponding SemanticApiVersion.

Remarks

For each supplied version, aliases are generated from Asp.Versioning.ApiVersion.MajorVersion, Asp.Versioning.ApiVersion.MinorVersion, and PatchVersion. If duplicate aliases are produced, the first version that contributed the alias is retained. The returned parser falls back to Asp.Versioning.ApiVersionParser.Default when a requested version is not one of the generated aliases.