Настройка ApiVersionDescription в .NetCore 3.0 без использования поставщика услуг сборки при запуске

Question

У меня есть следующий код в моем файле Startup.cs, чтобы захватить и обработать каждое из моих описаний версий API и добавить их в мой Swagger.

var apiVersionDescriptionProvider = services.BuildServiceProvider().GetService<IApiVersionDescriptionProvider>();

        // Register the Swagger generator, defining 1 or more Swagger documents
        services.AddSwaggerGen(setup =>
        {
            foreach (var description in apiVersionDescriptionProvider.ApiVersionDescriptions)
            {
                setup.SwaggerDoc(
                    $"MyAPISpecification{description.GroupName}",
                    new OpenApiInfo() 
                    { 
                        Title = "My API Specification",
                        Version = description.ApiVersion.ToString(), 
                    });
            }

Насколько я понимаю, я должен вводить реализацию в зависимости IApiVersionDescriptionProvider вместо использования BuildServiceProvider внутри метода ConfigureServices моего класса запуска, так как это предотвратит создание дополнительной копии одиночного файла.

Как бы я go об этом в этом конкретном c примере так как это метод, в котором настроены службы, поэтому у меня нет экземпляра, созданного к этому моменту, чтобы служба могла использовать без использования поставщика услуг построения.

Я читал где-то еще в StackOverflow об использовании параметров, но я не мог понять, как этот пример будет применяться в этом сценарии. Любая помощь будет принята с благодарностью, поскольку эта конфигурация Swagger основана на видео Pluralsight, опубликованном в конце 2019 года, и я ожидал, что оно будет правильным.

Заранее спасибо.

Answer 1

Вы можете использовать реализацию Интерфейс IConfigureOptions . Вот пример того, что вы пытаетесь сделать в репозитории:

namespace Microsoft.Examples
{
    using Microsoft.AspNetCore.Mvc.ApiExplorer;
    using Microsoft.Extensions.DependencyInjection;
    using Microsoft.Extensions.Options;
    using Microsoft.OpenApi.Models;
    using Swashbuckle.AspNetCore.SwaggerGen;
    using System;

    /// <summary>
    /// Configures the Swagger generation options.
    /// </summary>
    /// <remarks>This allows API versioning to define a Swagger document per API version after the
    /// <see cref="IApiVersionDescriptionProvider"/> service has been resolved from the service container.</remarks>
    public class ConfigureSwaggerOptions : IConfigureOptions<SwaggerGenOptions>
    {
        readonly IApiVersionDescriptionProvider provider;

        /// <summary>
        /// Initializes a new instance of the <see cref="ConfigureSwaggerOptions"/> class.
        /// </summary>
        /// <param name="provider">The <see cref="IApiVersionDescriptionProvider">provider</see> used to generate Swagger documents.</param>
        public ConfigureSwaggerOptions( IApiVersionDescriptionProvider provider ) => this.provider = provider;

        /// <inheritdoc />
        public void Configure( SwaggerGenOptions options )
        {
            // add a swagger document for each discovered API version
            // note: you might choose to skip or document deprecated API versions differently
            foreach ( var description in provider.ApiVersionDescriptions )
            {
                options.SwaggerDoc( description.GroupName, CreateInfoForApiVersion( description ) );
            }
        }

        static OpenApiInfo CreateInfoForApiVersion( ApiVersionDescription description )
        {
            var info = new OpenApiInfo()
            {
                Title = "Sample API",
                Version = description.ApiVersion.ToString(),
                Description = "A sample application with Swagger, Swashbuckle, and API versioning.",
                Contact = new OpenApiContact() { Name = "Bill Mei", Email = "bill.mei@somewhere.com" },
                License = new OpenApiLicense() { Name = "MIT", Url = new Uri( "https://opensource.org/licenses/MIT" ) }
            };

            if ( description.IsDeprecated )
            {
                info.Description += " This API version has been deprecated.";
            }

            return info;
        }
    }
}

Он добавляется в Startup.cs как:

services.AddTransient<IConfigureOptions<SwaggerGenOptions>, ConfigureSwaggerOptions>();

Ссылки: Шаблон параметров в ASP. NET Core / ASP. NET Управление версиями API