ContainerExtensions Class
Provides methods for registering services with an instance of IContainer for working with versions in HTTP APIs.
public static class ContainerExtensionsInheritance System.Object 🡒 ContainerExtensions
Methods
Section titled “Methods”ContainerExtensions.UseVersionedOpenApiSchemas(this IContainer) Method
Section titled “ContainerExtensions.UseVersionedOpenApiSchemas(this IContainer) Method”Registers an impementation of Swashbuckle.AspNetCore.SwaggerGen.IDocumentFilter with the container that adds api-version parameters to the request and response content types.
public static HAKOM.DependencyInjection.Core.Net.Api.IContainer UseVersionedOpenApiSchemas(this HAKOM.DependencyInjection.Core.Net.Api.IContainer container);Parameters
Section titled “Parameters”container IContainer
The container to add the service to.
Returns
Section titled “Returns”IContainer
The container itself for chaining additional setup calls.
ContainerExtensions.UseVersionedServiceInformation(this IContainer) Method
Section titled “ContainerExtensions.UseVersionedServiceInformation(this IContainer) Method”Registers an instance of IVersionedServiceInformation that contains information about the version of the HTTP API.
public static HAKOM.DependencyInjection.Core.Net.Api.IContainer UseVersionedServiceInformation(this HAKOM.DependencyInjection.Core.Net.Api.IContainer container);Parameters
Section titled “Parameters”container IContainer
The container to add the service to.
Returns
Section titled “Returns”IContainer
The container itself for chaining additional setup calls.
ContainerExtensions.UseVersionedServiceInformationSerializers(this IContainer) Method
Section titled “ContainerExtensions.UseVersionedServiceInformationSerializers(this IContainer) Method”Registers a serializer (see ISerializer) for IVersionedServiceInformation instances.
public static HAKOM.DependencyInjection.Core.Net.Api.IContainer UseVersionedServiceInformationSerializers(this HAKOM.DependencyInjection.Core.Net.Api.IContainer container);Parameters
Section titled “Parameters”container IContainer
The container to add the service to.
Returns
Section titled “Returns”IContainer
The container itself for chaining additional setup calls.
ContainerExtensions.UseVersionsFromGeneratedSupportedList(this IContainer) Method
Section titled “ContainerExtensions.UseVersionsFromGeneratedSupportedList(this IContainer) Method”Registers a filtered subset of the build-time generated supported-version list (from
SupportedHttpApiVersions.cs) as the active IVersionProvider,
overriding the full assembly-version list registered by
UseVersionsFromAssemblyAndNamespaces<TTypeInAssembly>(this IContainer).
Call this after UseVersionsFromAssemblyAndNamespaces so that
HAKOM.Versioning.Http.Net.VersionedNamespaceEndpointSelector restricts
unconstrained namespace-versioned routing to only the currently supported versions.
public static HAKOM.DependencyInjection.Core.Net.Api.IContainer UseVersionsFromGeneratedSupportedList(this HAKOM.DependencyInjection.Core.Net.Api.IContainer container);Parameters
Section titled “Parameters”container IContainer
The container to register with.
Returns
Section titled “Returns”IContainer
The container itself for call chaining.
Exceptions
Section titled “Exceptions”System.ArgumentNullException
Thrown if container is null.
Remarks
Section titled “Remarks”The version list is filtered by HAKOM.Versioning.Http.Net.SupportedHttpApiVersions.ApplySupportedVersionsPolicy(System.Collections.Generic.IReadOnlyList{System.String}) before being registered. See that method for the exact retention rules.
When the build-time generated version list is empty — for example when building from a
repository checkout that has no merged release tags — this method is a no-op and the
existing IVersionProvider registration is left intact. This prevents the
documentation pipeline from receiving an empty version list and crashing during the
swagger tofile step.
ContainerExtensions.UseVersionStringSerializers(this IContainer) Method
Section titled “ContainerExtensions.UseVersionStringSerializers(this IContainer) Method”Registers a serializer (see ISerializer) for IVersion instances that serializes to/from a simple string.
public static HAKOM.DependencyInjection.Core.Net.Api.IContainer UseVersionStringSerializers(this HAKOM.DependencyInjection.Core.Net.Api.IContainer container);Parameters
Section titled “Parameters”container IContainer
The container to add the service to.
Returns
Section titled “Returns”IContainer
The container itself for chaining additional setup calls.