Группировка и управление версиями не очень хорошо работают вместе в swagger в asp. net core 3.1 web api - PullRequest
Новая
       63

Группировка и управление версиями не очень хорошо работают вместе в swagger в asp. net core 3.1 web api

0 голосов
/ 01 марта 2020

Я использую Asp. Net Core 3.1 для создания своего API. Я использую Swagger для создания документа для моего API. Я решил сделать группировку по моему документу чванства на основе контроллера. Поэтому я закончил так:

Запуск - ConfigureServices: 

options.SwaggerDoc(
    "LibraryOpenAPISpecificationCategories",
    ...

Запуск - настройка: 

options.SwaggerEndpoint(
    "/swagger/LibraryOpenAPISpecificationCategories/swagger.json",
    "Library API (Categories)");

Контроллер: 

[Route("api/categories")]
[ApiController]
[ApiExplorerSettings(GroupName = "LibraryOpenAPISpecificationCategories")]
public class CategoriesController : ControllerBase

До этого момента все работало нормально. Когда я добавил версии, документ Swagger перестал отображать методы в контроллере. Я пытался создать группировку внутри версии, чтобы в каждой версии были такие группы, как

V1 -> LibraryOpenAPISpecificationCategories

V1 -> LibraryOpenAPISpecificationItems

V2 -> LibraryOpenAPISpecificationCategories

V2 -> LibraryOpenAPISpecificationItems

Вот что я сделал,

Запуск - ConfigureServices: 

services.AddVersionedApiExplorer(options =>
{
    options.GroupNameFormat = "'v'VV";
});

services.AddApiVersioning(options =>
{
    options.AssumeDefaultVersionWhenUnspecified = true;
    options.DefaultApiVersion = new ApiVersion(1, 0);
    options.ReportApiVersions = true;
});

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

services.AddSwaggerGen(options =>
{
    foreach (var description in apiVersionDescriptionProvider.ApiVersionDescriptions)
    {
        options.SwaggerDoc(
            $"LibraryOpenAPISpecificationCategories{description.GroupName}",
            ...

Запуск - Сконфигурируйте: 

app.UseSwaggerUI(options =>
{
    foreach (var description in apiVersionDescriptionProvider.ApiVersionDescriptions)
    {
        options.SwaggerEndpoint(
            $"/swagger/LibraryOpenAPISpecificationCategories{description.GroupName}/swagger.json",
            $"Library API (Categories) {description.GroupName.ToUpperInvariant()}");

Контроллер: 

[Route("api/categories")]
[ApiController]
[ApiExplorerSettings(GroupName = "LibraryOpenAPISpecificationCategories")]
public class CategoriesController : ControllerBase

Нет ошибок отображается в документе Swagger. Пожалуйста, помогите мне, где я иду не так. Я что-то упустил?

1 Ответ

0 голосов
/ 01 марта 2020

После некоторого анализа я понял, что пропустил DocInclusionPredicate в AddSwaggerGen в моем ConfigureServices.

Вот как я решил, 

options.DocInclusionPredicate((documentName, apiDescription) =>
{
    var actionApiVersionModel = apiDescription.ActionDescriptor
    .GetApiVersionModel(ApiVersionMapping.Explicit | ApiVersionMapping.Implicit);

    var apiExplorerSettingsAttribute = (ApiExplorerSettingsAttribute)apiDescription.ActionDescriptor.EndpointMetadata.First(x => x.GetType().Equals(typeof(ApiExplorerSettingsAttribute)));

    if (actionApiVersionModel == null)
    {
        return true;
    }

    if (actionApiVersionModel.DeclaredApiVersions.Any())
    {
        return actionApiVersionModel.DeclaredApiVersions.Any(v =>
        $"{apiExplorerSettingsAttribute.GroupName}v{v.ToString()}" == documentName);
    }
    return actionApiVersionModel.ImplementedApiVersions.Any(v =>
        $"{apiExplorerSettingsAttribute.GroupName}v{v.ToString()}" == documentName);
});

Надеюсь, это поможет кто-то там.

...