Swagger не находит действия ApiVersion-ed - PullRequest
Новая
       23

Swagger не находит действия ApiVersion-ed

1 голос
/ 06 февраля 2020

Я создаю Web API в ASP. NET Core и экспериментирую с несколькими версиями. Я создаю документы Swagger для каждой версии, следуя этим инструкциям: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/README.md#customize -the-action-selection-process

У меня есть 2 версии одного и того же действия, определенного так: 

namespace Web.Api
{
    [ApiController]
    [Area("api")]
    [Route("[area]/[controller]")]
    public abstract class MyApiControllerBase : ControllerBase
    {

    }
}

namespace Web.Api.V1
{
    public class TestController : MyApiControllerBase
    {
        [HttpGet]
        [ApiVersion("1.0")]
        public IActionResult Get()
        {
            return Ok("Version 1.0 endpoint.");
        }
    }
}

namespace Web.Api.V2
{
    public class TestController : MyApiControllerBase
    {
        [HttpGet]
        [ApiVersion("2.0")]
        public IActionResult Get()
        {
            return Ok("Version 2.0 endpoint.");
        }
    }
}

И мой Swagger Gen настроен следующим образом в Startup.cs: 

services.AddSwaggerGen(options =>
{
    options.DocInclusionPredicate((docName, apiDesc) =>
    {
        if (!apiDesc.TryGetMethodInfo(out MethodInfo methodInfo))
        {
            return false;
        }

        IEnumerable<ApiVersion> versions = methodInfo.DeclaringType
            .GetCustomAttributes(true)
            .OfType<ApiVersionAttribute>()
            .SelectMany(a => a.Versions);

        return versions.Any(v => $"v{v.ToString()}" == docName);
    });

    options.SwaggerDoc("v1.0", new OpenApiInfo { Title = "My API", Version = "v1.0" });
    options.SwaggerDoc("v2.0", new OpenApiInfo { Title = "My API", Version = "v2.0" });
});

Однако, когда я посещаю мой Swagger UI, он говорит: «В spe c не определены операции!» как для v1.0, так и для v2.0. Если я проверяю DocInclusionPredicate при загрузке Swagger, то делаем c, кажется, что атрибут ApiVersion не берется, и поэтому объясняет, почему они не включены в документы. Например, когда Web.Api.V2.TestController.Get передается в качестве аргумента apiDesc, это то, что найдено для атрибутов:

Атрибуты

Только ApiControllerAttribute, AreaAttribute, RouteAttribute и ControllerAttribute найдены. Все это атрибуты базовых классов, а не непосредственно самого действия TestController или Get().

1 Ответ

0 голосов
/ 06 февраля 2020

Для asp. net core 3.0 вы можете выполнить следующие шаги:

1.Install Swashbuckle.AspNetCore 5.0.0

2.Install Microsoft.AspNetCore.Mvc.Versioning 4.0.0

3.Установите Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer 4.0.0

4. Измените свой контроллер, как показано ниже (ApiVersion должен быть объявлен на контроллере): 

[Route("api/v{version:apiVersion}/[controller]")]
[ApiVersion("1.0")]
public class TestController : MyApiControllerBase
{
    [HttpGet]      
    public IActionResult Get()
    {
        return Ok("Version 1.0 endpoint.");
    }
}
[Route("api/v{version:apiVersion}/[controller]")]
[ApiVersion("2.0")]
public class TestController : MyApiControllerBase
{
    [HttpGet]        
    public IActionResult Get()
    {
        return Ok("Version 2.0 endpoint.");
    }
}

5.Startup.cs (Обратите внимание, что вам нужно использовать services.AddVersionedApiExplorer и установить options.SubstituteApiVersionInUrl=true, чтобы сообщить Swagger о необходимости замены версии в маршруте контроллера и настроить версию API:): 

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();

    services.AddApiVersioning(o => {
        o.ReportApiVersions = true;
        o.AssumeDefaultVersionWhenUnspecified = true;
        o.DefaultApiVersion = new ApiVersion(1, 0);
    });
    services.AddVersionedApiExplorer(o =>
    {
        o.GroupNameFormat = "'v'VVV";
        o.SubstituteApiVersionInUrl = true;
    });

    services.AddSwaggerGen(options =>
    {
        options.DocInclusionPredicate((docName, apiDesc) =>
        {
            if (!apiDesc.TryGetMethodInfo(out MethodInfo methodInfo))
            {
                return false;
            }

            IEnumerable<ApiVersion> versions = methodInfo.DeclaringType
                .GetCustomAttributes(true)
                .OfType<ApiVersionAttribute>()
                .SelectMany(a => a.Versions);

            return versions.Any(v => $"v{v.ToString()}" == docName);
        });

        options.SwaggerDoc("v1.0", new OpenApiInfo { Title = "My API", Version = "v1.0" });
        options.SwaggerDoc("v2.0", new OpenApiInfo { Title = "My API", Version = "v2.0" });
    });
}

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseHttpsRedirection();
    app.UseApiVersioning();
    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1.0/swagger.json", "V1 Docs");
        c.SwaggerEndpoint("/swagger/v2.0/swagger.json", "V2 Docs");
    });

    app.UseRouting();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}
...