Question

我正在寻找一种方法，以可配置的方式使用SwashBuckle在Swagger文档中显示/隐藏WebAPI路由。添加[ApiExplorerSettings(IgnoreApi = true)]确实会隐藏路由，但我每次想要更改时都需要重新编译。

我已经研究过创建一个IOperationFilter来处理我定义的自定义属性。这样我可以使用[SwaggerTag("MobileOnly")]装饰路线并检查web.config或其他内容以查看是否应显示路线。属性定义如下：

public class SwaggerTagAttribute : Attribute
{
    public string[] Tags { get; private set; }

    public SwaggerTagAttribute(params string[] tags)
    {
        this.Tags = tags;
    }
}

定义了检测属性的IOperationFilter，并在此处定义了删除路径的IDocumentFilter：

public class RemoveTaggedOperationsFilter : IOperationFilter, IDocumentFilter
{
    private List<string> TagsToHide;

    public RemoveTaggedOperationsFilter()
    {
        TagsToHide = ConfigurationManager.AppSettings["TagsToHide"].Split(',').ToList();
    }

    public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
    {
        var tags = apiDescription.ActionDescriptor
            .GetCustomAttributes<SwaggerTagAttribute>()
            .Select(t => t.Tags)
            .FirstOrDefault();

        if (tags != null && TagsToHide.Intersect(tags).Any())
        {
            operation.tags = new List<string> {"Remove Me "};
        }
    }

    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
    {
        foreach (var value in swaggerDoc.paths.Values)
        {
            if (value.post != null && value.post.tags.Contains("Remove Me"))
                value.post = null;

            if (value.get != null && value.get.tags.Contains("Remove Me"))
                value.get = null;

            if (value.put != null && value.put.tags.Contains("Remove Me"))
                value.put = null;

            if (value.delete != null && value.delete.tags.Contains("Remove Me"))
                value.delete = null;
        }
    }
}

并注册为：

 GlobalConfiguration.Configuration
            .EnableSwagger(c =>
                {
                    c.OperationFilter<RemoveTaggedOperationsFilter>();
                    c.DocumentFilter<RemoveTaggedOperationsFilter>();
                });

我觉得，当我之前访问它时，标记要删除的东西是低效和hacky。我有没有办法从IOperationFilter.Apply内删除路线，而不是等待IDocumentFilter并扫描它？

Answer 1

之前有人发布了一个答案，并表示他们一旦有机会就会发布代码。他们出于某种原因删除了他们的答案，但它让我得到了更好的解决方案。

您可以使用IOperationFilter查找自定义属性并一次性删除，而不是使用IDocumentFilter标记路线，然后使用IDocumentFilter删除路线。代码如下：

public class HideTaggedOperationsFilter : IDocumentFilter
{
    private List<string> TagsToHide;

    public HideTaggedOperationsFilter()
    {
        TagsToHide = ConfigurationManager.AppSettings["TagsToHide"].Split(',').ToList();
    }

    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
    {
        if (_tagsToHide == null) return;

        foreach (var apiDescription in apiExplorer.ApiDescriptions)
        {
            var tags = apiDescription.ActionDescriptor
                .GetCustomAttributes<SwaggerTagAttribute>()
                .Select(t => t.Tags)
                .FirstOrDefault();

            if (tags == null || !_tagsToHide.Intersect(tags).Any())
                continue;

            var route = "/" + apiDescription.Route.RouteTemplate.TrimEnd('/');
            swaggerDoc.paths.Remove(route);
        }
    }
}

public class SwaggerTagAttribute : Attribute
{
    public string[] Tags { get; }

    public SwaggerTagAttribute(params string[] tags)
    {
        this.Tags = tags;
    }
}

注册IDocumentFilter：

GlobalConfiguration.Configuration.EnableSwagger(c =>
{
    ...
    c.DocumentFilter<HideTaggedOperationsFilter>();
});

然后装饰这样的路线：

 [SwaggerTag("MobileOnly")]
 public IHttpActionResult SendTest(Guid userId)
 {
    return OK();
 }

Edit:在SwitBuckle的GitHub页面上有一些问题帖子建议在swaggerDoc.path的{{1}}上将每个HTTP谓词设置为空。我发现这打破了许多自动代码生成器，如AutoRest，所以我只是删除整个路径。（看起来也更简洁）

在SwashBuckle中删除带有IOperationFilter的路由

1 个答案: