web-dev-qa-db-ja.com

Swashbuckleを使用してWeb APIのSwaggerドキュメントからメソッドを省略する方法

Swashbuckle を使用してAPIドキュメントが自動的に生成されるC＃ASP.NET WebAPIアプリケーションがあります。ドキュメントから特定のメソッドを除外できるようにしたい UI出力。

モデルまたはスキーマフィルターの追加と関係があると思いますが、何をすべきかは明らかではありません。メソッドから出力を完全に削除するのではなく、メソッドの出力を変更する方法。

前もって感謝します。

c#asp.net.netswagger
96
SteveWilkinson

次の属性をコントローラーとアクションに追加して、生成されたドキュメントからそれらを除外することができます：[ApiExplorerSettings(IgnoreApi = true)]

210
mikesigs

ドキュメントフィルターで生成されたswaggerドキュメントから「操作」を削除できます-動詞をnullに設定するだけです（ただし、他の方法もあります）

次のサンプルでは、​​GET動詞のみが許可され、 この問題 から取得されます。

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;
        }
    }
}

そして、あなたのswagger設定で：

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

    conf.DocumentFilter<RemoveVerbsFilter>();
});
13
Dave Transom

誰かがgithubにソリューションを投稿したので、ここに貼り付けます。すべてのクレジットは彼に行きます。 https://github.com/domaindrivendev/Swashbuckle/issues/153#issuecomment-213342771

最初に属性クラスを作成します

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

次に、Document Filterクラスを作成します

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);
        }
    }
}

次に、Swagger Configクラスで、そのドキュメントフィルターを追加します

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

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

最後のステップは、Swashbuckleでドキュメントを生成したくないコントローラーまたはメソッドに[HideInDocsAttribute]属性を追加することです。

11
Paulo Pozeti

パスアイテムの辞書エントリを完全に削除したいと思います。

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

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

このアプローチでは、生成されたswagger.json定義で「空の」アイテムを取得しません。

3
Denis Biondic

フィルターを作る

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);
            }
        }
    }
}

属性を作成する

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

Startup.csで適用する

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

Swagger JSONに含めるメソッドとコントローラーに[SwaggerTag]属性を追加します

1
Rowan Stringer

@spottedmahns answer に基づきます。私の仕事はその逆でした。許可されているもののみを表示します。

フレームワーク：.NetCore 2.1; Swagger：3.0.0

追加された属性

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

カスタム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);
            }
        }
    }
}

ConfigureServicesコード：

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

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