Показывать только выбранные контроллеры в пользовательском интерфейсе swagger-swashbuckle

вы можете использовать ApiExplorerSettings на любом контроллере, чтобы полностью игнорировать контроллер или метод.

[ApiExplorerSettings(IgnoreApi = true)]
public class MyController
{
    [ApiExplorerSettings(IgnoreApi = true)]
    public string MyMethod
    {
      ...
    }
}

Используя фильтр документов swashbuckle, вы можете удалить некоторые элементы сгенерированной спецификации постфактум, и тогда они не будут включены в интегрированный swagger-ui. Создайте класс, как показано ниже:

using System;
using System.Web.Http.Description;
using Swashbuckle.Swagger;

internal class SwaggerFilterOutControllers : IDocumentFilter
{
    void IDocumentFilter.Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
    {
        foreach (ApiDescription apiDescription in apiExplorer.ApiDescriptions)
        {
            Console.WriteLine(apiDescription.Route.RouteTemplate);

            if ((apiDescription.RelativePathSansQueryString().StartsWith("api/System/"))
                || (apiDescription.RelativePath.StartsWith("api/Internal/"))
                || (apiDescription.Route.RouteTemplate.StartsWith("api/OtherStuff/"))
                )
            {
                swaggerDoc.paths.Remove("/" + apiDescription.Route.RouteTemplate.TrimEnd('/'));
            }
        }
    }
}

а затем отредактируйте файл SwaggerConfig.cs, чтобы включить фильтр:

        GlobalConfiguration.Configuration
            .EnableSwagger(c =>
                    c.DocumentFilter<SwaggerFilterOutControllers>();

Обратите внимание, что, хотя контроллеры были удалены из спецификации, другие элементы, такие как модели результатов, по-прежнему будут включены в спецификацию и могут по-прежнему замедлять загрузку страницы.

Это также может быть медленным просто из-за перечисления всех контроллеров / моделей и т. Д. В первую очередь, и в этом случае это может не помочь.

Изменить: я заметил, что при каждом просмотре страницы пользовательского интерфейса все определение будет восстанавливаться (что может быть вредным в вашем сценарии). К счастью, это очень легко кэшировать (что должно быть нормально, поскольку для большинства людей он не должен меняться во время выполнения).

Добавьте это в свою конфигурацию:

c.CustomProvider((defaultProvider) => new CachingSwaggerProvider(defaultProvider));

и используйте этот класс, бесстыдно скопированный с https://github.com/domaindrivendev/Swashbuckle/blob/master/Swashbuckle.Dummy.Core/App_Start/CachingSwaggerProvider.cs

using Swashbuckle.Swagger;
using System.Collections.Concurrent;

namespace <your namespace>
{
    public class CachingSwaggerProvider : ISwaggerProvider
    {
        private static ConcurrentDictionary<string, SwaggerDocument> _cache =
            new ConcurrentDictionary<string, SwaggerDocument>();

        private readonly ISwaggerProvider _swaggerProvider;

        public CachingSwaggerProvider(ISwaggerProvider swaggerProvider)
        {
            _swaggerProvider = swaggerProvider;
        }

        public SwaggerDocument GetSwagger(string rootUrl, string apiVersion)
        {
            string cacheKey = string.Format("{0}_{1}", rootUrl, apiVersion);
            return _cache.GetOrAdd(cacheKey, (key) => _swaggerProvider.GetSwagger(rootUrl, apiVersion));
        }
    }
}

В ответ на предыдущий ответ это обновленный код для ASP.NET Core. Я также добавил функцию удаления моделей.

using System;
using System.Linq;
using System.Web.Http;
using Swashbuckle.AspNetCore.SwaggerGen;
using Swashbuckle.AspNetCore.Swagger;

using Microsoft.AspNetCore.Mvc.ApiExplorer;

internal class SwaggerFilterOutControllers : IDocumentFilter
{

    void IDocumentFilter.Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
    {
        foreach (var item in swaggerDoc.Paths.ToList())
        {
            if (!(item.Key.ToLower().Contains("/api/endpoint1") ||
                  item.Key.ToLower().Contains("/api/endpoint2")))
            {
                swaggerDoc.Paths.Remove(item.Key);
            }
        }

        swaggerDoc.Definitions.Remove("Model1");
        swaggerDoc.Definitions.Remove("Model2");
    }
}

swaggerDoc.paths.Remove("/" + apiDescription.Route.RouteTemplate.TrimEnd('/')); мне ничего не удалил. Так,

internal class SwaggerFilterOutControllers : IDocumentFilter
{
    void IDocumentFilter.Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
    {
        foreach (var item in swaggerDoc.Paths.ToList())
        {
            if (!(item.Key.ToLower().Contains("/api/v1/xxxx") ||
                  item.Key.ToLower().Contains("/api/v1/yyyy")))
            {
                swaggerDoc.Paths.Remove(item.Key);
            }
        }
    }
}

Вы можете попробовать это. Вы APIExplorerSetting, чтобы указать API, которые будут включены в определенную группу.

Начните с определения нескольких документов Swagger в Startup.cs:

services.AddSwaggerGen(c => { 
    c.SwaggerDoc("v1", new OpenApiInfo { 
        Title = "My API - V1",
        Version = "v1" 
    });
    c.SwaggerDoc("v2", new OpenApiInfo {
        Title = "My API - V2",
        Version = "v2"
    });
});

Затем украсьте отдельный контроллер указанными выше группами:

[ApiExplorerSettings(GroupName = "v2")]

Ссылка: https://github.com/domaindrivendev/Swashbuckle.AspNetCore#generate-multiple-swagger-documents