不要在Swashbuckle(Swagger)中显示端点。
创始人
2025-01-11 04:31:01
0

要在Swashbuckle(Swagger)中隐藏端点,您可以使用Swagger的过滤器功能。以下是一个示例代码,演示如何在Swashbuckle中隐藏特定的端点:

using System.Linq;
using Microsoft.AspNetCore.Mvc;
using Swashbuckle.AspNetCore.Swagger;
using Swashbuckle.AspNetCore.SwaggerGen;

public class HideSwaggerEndpointsFilter : IDocumentFilter
{
    public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
    {
        var hiddenEndpoints = new[] { "/api/hiddenEndpoint" };

        foreach (var endpoint in swaggerDoc.Paths.ToList())
        {
            if (hiddenEndpoints.Any(e => endpoint.Key.Contains(e)))
            {
                swaggerDoc.Paths.Remove(endpoint.Key);
            }
        }
    }
}

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // ...

        services.AddSwaggerGen(c =>
        {
            c.DocumentFilter();
        });

        // ...
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        // ...

        app.UseSwagger();
        app.UseSwaggerUI(c =>
        {
            c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
        });

        // ...
    }
}

在上面的示例中,我们创建了一个名为HideSwaggerEndpointsFilter的自定义Swagger文档过滤器。在Apply方法中,我们定义了要隐藏的端点的路径,并使用swaggerDoc.Paths.Remove方法从Swagger文档中移除它们。

然后,在ConfigureServices方法中,我们将自定义的Swagger文档过滤器添加到Swagger生成器中。最后,在Configure方法中,我们启用Swagger和Swagger UI。

请根据您的实际需要修改示例代码中的路径和端点信息。

相关内容

热门资讯

AWSECS:访问外部网络时出... 如果您在AWS ECS中部署了应用程序,并且该应用程序需要访问外部网络,但是无法正常访问,可能是因为...
AWSElasticBeans... 在Dockerfile中手动配置nginx反向代理。例如,在Dockerfile中添加以下代码:FR...
AWR报告解读 WORKLOAD REPOSITORY PDB report (PDB snapshots) AW...
AWS管理控制台菜单和权限 要在AWS管理控制台中创建菜单和权限,您可以使用AWS Identity and Access Ma...
北信源内网安全管理卸载 北信源内网安全管理是一款网络安全管理软件,主要用于保护内网安全。在日常使用过程中,卸载该软件是一种常...
​ToDesk 远程工具安装及... 目录 前言 ToDesk 优势 ToDesk 下载安装 ToDesk 功能展示 文件传输 设备链接 ...
Azure构建流程(Power... 这可能是由于配置错误导致的问题。请检查构建流程任务中的“发布构建制品”步骤,确保正确配置了“Arti...
群晖外网访问终极解决方法:IP... 写在前面的话 受够了群晖的quickconnet的小水管了,急需一个新的解决方法&#x...
AWSECS:哪种网络模式具有... 使用AWS ECS中的awsvpc网络模式来获得最佳性能。awsvpc网络模式允许ECS任务直接在V...
不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...