Asp.Net Core WebAPI使用Swagger时API隐藏和分组详解

Asp.Net Core WebAPI使用Swagger是一种相对简便的方式来生成API文档，并提供了可视化的界面方便查看和调试。但是，在使用Swagger生成文档时，我们可能会遇到一些问题，比如API隐藏和分组问题。本文将详细介绍如何解决这些问题。

防止API被泄露

在生成API文档时，有些API可能是敏感的，我们希望这些API不被泄露。此时，我们可以使用Swagger提供的ApiExplorerSettings属性来防止API被泄露。

示例代码：

[ApiExplorerSettings(IgnoreApi = true)]
[HttpGet("sensitiveData")]
public IActionResult GetSensitiveData()
{
   // 返回敏感数据
}

在上述示例代码中，我们在API中使用了ApiExplorerSettings属性，并设置了IgnoreApi为true，这样就可以防止该API被Swagger生成到API文档中。

分组API数据

当我们有大量的API时，文档可能会变得混乱和不易查找。为了更好地组织和查看API文档，我们可以将API数据分组。在使用Swagger时，我们可以通过创建多个分组来实现这一目的。

示例代码：

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

    c.SwaggerDoc("v2", new OpenApiInfo
    {
        Title = "API V2",
        Version = "v2"
    });

    c.DocInclusionPredicate((version, desc) =>
    {
        var versions = desc.CustomAttributes()
            .OfType<ApiVersionAttribute>()
            .SelectMany(attr => attr.Versions);

        return versions.Any(v => $"v{v}" == version);
    });
});

在上述示例代码中，我们创建了两个分组：V1和V2。然后，我们通过DocInclusionPredicate指定了当API使用了特定版本号时，将其包含在特定版本的文档中。

[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/[controller]")]
public class ValuesController : ControllerBase
{
    [HttpGet]
    public ActionResult<IEnumerable<string>> Get()
    {
        return new string[] { "value1", "value2" };
    }
}

在上述示例代码中，我们使用了ApiVersion属性来指定API使用的版本号。

通过以上的示例，我们可以清楚地了解到如何在Asp.Net Core WebAPI中使用Swagger生成API文档，并解决API隐藏和分组问题。