Asp。net Core招摇过市：如何显示GET类型的API

Question

如何仅显示类型为GET in Swagger page的API并隐藏其他API？我发现属性ApiExplorerSettings（IgnoreApi=true）可以从Swagger页面隐藏API，但是我有很多API要隐藏，我需要一种根据其HTTP类型隐藏API的方法。我尝试过这种方法：

 public class SwaggerFilter : IDocumentFilter
    {
        public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
        {
            var nonGetPaths = swaggerDoc.Paths.Where(x => x.Value.Operations.First().Key != OperationType.Get);
            var count=nonGetPaths.Count();
            foreach (var item in nonGetPaths)
            {
                swaggerDoc.Paths.Remove(item.Key);
            }
        }
    }

但没用

Answer 1

编写一个自定义过滤器，如下所示：

public class SwaggerFilter : IDocumentFilter
{
    public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
    {
        
        foreach (var path in swaggerDoc.Paths)
        {
          foreach (var key in path.Value.Operations.Keys )
          {
            if (key != OperationType.Get)
            {
                swaggerDoc.Paths.Remove(path.Key);
            }
          }
       }
       
    }
}

然后在program.cs配置（. Net 6）

//.......
builder.Services.AddSwaggerGen(x=>x.DocumentFilter<SwaggerFilter>());
//......

我不添加[ApiExplorerSetting（IgnoreApi=true）]在我的apictroller中，它工作得很好。

但是，确保Getendpoint和其他类型的endpoint在同一个控制器中具有不同的路由，您可以在Getendpoint上添加像[HttpGet（"/get"）]这样的属性路由。如果您在同一个控制器中这样写：

       [HttpPost]
        public IActionResult Post()
        {
            return Ok();
        }

        [HttpGet]
        public IActionResult Get()
        {
            return NotFound();
        }

获取和Postendpoint将具有相同的路径。swaggerDoc。路径。删除（xxx）；将删除所有它们。

重新使用：

之前

之后