Jak pominąć metody z dokumentacji Swaggera w WebAPI przy użyciu Swashbuckle

Mam aplikację WebAPI C # ASP.NET z dokumentacją API generowaną automatycznie przy użyciu Swashbuckle . Chcę móc pominąć pewne metody w dokumentacji, ale nie mogę znaleźć sposobu, aby powiedzieć Swaggerowi, aby nie uwzględniał ich w danych wyjściowych interfejsu użytkownika programu Swagger.

Czuję, że ma to coś wspólnego z dodaniem modelu lub filtru schematu, ale nie jest oczywiste, co należy zrobić, a dokumentacja wydaje się zawierać tylko przykłady tego, jak zmodyfikować dane wyjściowe dla metody, a nie usunąć je całkowicie z wyniku.

Z góry dziękuję.

Możesz dodać następujący atrybut do kontrolerów i akcji, aby wykluczyć je z wygenerowanej dokumentacji: [ApiExplorerSettings(IgnoreApi = true)]

Ktoś opublikował rozwiązanie na githubie, więc wkleię je tutaj. Wszystkie kredyty trafiają do niego. https://github.com/domaindrivendev/Swashbuckle/issues/153#issuecomment-213342771

Najpierw utwórz klasę Attribute

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class HideInDocsAttribute : Attribute
{
}

Następnie utwórz klasę filtru dokumentów

public class HideInDocsFilter : IDocumentFilter
{
    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
    {
        foreach (var apiDescription in apiExplorer.ApiDescriptions)
        {
            if (!apiDescription.ActionDescriptor.ControllerDescriptor.GetCustomAttributes<HideInDocsAttribute>().Any() && !apiDescription.ActionDescriptor.GetCustomAttributes<HideInDocsAttribute>().Any()) continue;
            var route = "/" + apiDescription.Route.RouteTemplate.TrimEnd('/');
            swaggerDoc.paths.Remove(route);
        }
    }
}

Następnie w klasie Swagger Config dodaj ten filtr dokumentu

public class SwaggerConfig
{
    public static void Register(HttpConfiguration config)
    {
        var thisAssembly = typeof(SwaggerConfig).Assembly;

        config
             .EnableSwagger(c =>
                {
                    ...                       
                    c.DocumentFilter<HideInDocsFilter>();
                    ...
                })
            .EnableSwaggerUi(c =>
                {
                    ...
                });
    }
}

Ostatnim krokiem jest dodanie atrybutu [HideInDocsAttribute] do kontrolera lub metody, której nie chcesz, aby Swashbuckle generował dokumentację.

Możesz usunąć "operacje" z dokumentu swagger po jego wygenerowaniu za pomocą filtru dokumentu - po prostu ustaw czasownik na null(chociaż mogą być również inne sposoby, aby to zrobić)

Poniższy przykład dopuszcza tylko GETczasowniki - i pochodzi z tego problemu .

class RemoveVerbsFilter : IDocumentFilter
{
    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
    {
        foreach (PathItem path in swaggerDoc.paths.Values)
        {
            path.delete = null;
            //path.get = null; // leaving GET in
            path.head = null;
            path.options = null;
            path.patch = null;
            path.post = null;
            path.put = null;
        }
    }
}

aw twojej konfiguracji swagger:

...EnableSwagger(conf => 
{
    // ...

    conf.DocumentFilter<RemoveVerbsFilter>();
});

Wolałbym całkowicie usunąć wpisy słownika dla elementów ścieżki:

var pathsToRemove = swaggerDoc.Paths
                .Where(pathItem => !pathItem.Key.Contains("api/"))
                .ToList();

foreach (var item in pathsToRemove)
{
    swaggerDoc.Paths.Remove(item.Key);
}

Przy takim podejściu w wygenerowanej definicji swagger.json nie uzyskasz „pustych” elementów.

Może komuś pomóc, ale podczas programowania (debugowania) lubimy ujawniać całe kontrolery i / lub akcje, a następnie ukrywać je podczas produkcji (kompilacja wydania)

#if DEBUG
    [ApiExplorerSettings(IgnoreApi = false)]
#else
    [ApiExplorerSettings(IgnoreApi = true)]
#endif  

Zrób filtr

public class SwaggerTagFilter : IDocumentFilter
{
    public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
    {
        foreach(var contextApiDescription in context.ApiDescriptions)
        {
            var actionDescriptor = (ControllerActionDescriptor)contextApiDescription.ActionDescriptor;

    if(!actionDescriptor.ControllerTypeInfo.GetCustomAttributes<SwaggerTagAttribute>().Any() && 
    !actionDescriptor.MethodInfo.GetCustomAttributes<SwaggerTagAttribute>().Any())
            {
                var key = "/" + contextApiDescription.RelativePath.TrimEnd('/');
            swaggerDoc.Paths.Remove(key);
            }
        }
    }
}

Utwórz atrybut

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class SwaggerTagAttribute : Attribute
{
}

Zastosuj w startup.cs

 services.AddSwaggerGen(c => {
            c.SwaggerDoc(1,
                new Info { Title = "API_NAME", Version = "API_VERSION" });
            c.DocumentFilter<SwaggerTagFilter>(); // [SwaggerTag]
        });

Dodaj atrybut [SwaggerTag] do metod i kontrolerów, które chcesz uwzględnić w Swagger JSON

Dodaj to do swoich metod, które chcesz pominąć -

[ApiExplorerSettings(IgnoreApi=true)]

Na podstawie odpowiedzi @spottedmahns . Moje zadanie było odwrotnie. Pokaż tylko te, które są dozwolone.

Struktury: .NetCore 2.1; Swagger: 3.0.0

Dodatkowy atrybut

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class ShowInSwaggerAttribute : Attribute
{
}

I zaimplementuj niestandardowy IDocumentFilter

public class ShowInSwaggerFilter : IDocumentFilter
{
    public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
    {

        foreach (var contextApiDescription in context.ApiDescriptions)
        {
            var actionDescriptor = (ControllerActionDescriptor) contextApiDescription.ActionDescriptor;

            if (actionDescriptor.ControllerTypeInfo.GetCustomAttributes<ShowInSwaggerAttribute>().Any() ||
                actionDescriptor.MethodInfo.GetCustomAttributes<ShowInSwaggerAttribute>().Any())
            {
                continue;
            }
            else
            {
                var key = "/" + contextApiDescription.RelativePath.TrimEnd('/');
                var pathItem = swaggerDoc.Paths[key];
                if(pathItem == null)
                    continue;

                switch (contextApiDescription.HttpMethod.ToUpper())
                {
                    case "GET":
                        pathItem.Get = null;
                        break;
                    case "POST":
                        pathItem.Post = null;
                        break;
                    case "PUT":
                        pathItem.Put = null;
                        break;
                    case "DELETE":
                        pathItem.Delete = null;
                        break;
                }

                if (pathItem.Get == null  // ignore other methods
                    && pathItem.Post == null 
                    && pathItem.Put == null 
                    && pathItem.Delete == null)
                    swaggerDoc.Paths.Remove(key);
            }
        }
    }
}

Kod ConfigureServices :

public void ConfigureServices(IServiceCollection services)
{
     // other code

    services.AddSwaggerGen(c =>
    {
        // other configurations
        c.DocumentFilter<ShowInSwaggerFilter>();
    });
}

dodaj jedną linię SwaggerConfig c.DocumentFilter ();

public class HideInDocsFilter : IDocumentFilter
    {
        public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
        { 
var pathsToRemove = swaggerDoc.Paths
                .Where(pathItem => !pathItem.Key.Contains("api/"))
                .ToList();

foreach (var item in pathsToRemove)
{
    swaggerDoc.Paths.Remove(item.Key);
}
    }
}

Jeśli chcesz zapobiec wyświetlaniu w NestJS użycia

 @ApiExcludeEndpoint(true)