不要在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。

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

相关内容

热门资讯

保存时出现了1个错误,导致这篇... 当保存文章时出现错误时,可以通过以下步骤解决问题:查看错误信息:查看错误提示信息可以帮助我们了解具体...
汇川伺服电机位置控制模式参数配... 1. 基本控制参数设置 1)设置位置控制模式   2)绝对值位置线性模...
不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...
表格中数据未显示 当表格中的数据未显示时,可能是由于以下几个原因导致的:HTML代码问题:检查表格的HTML代码是否正...
本地主机上的图像未显示 问题描述:在本地主机上显示图像时,图像未能正常显示。解决方法:以下是一些可能的解决方法,具体取决于问...
表格列调整大小出现问题 问题描述:表格列调整大小出现问题,无法正常调整列宽。解决方法:检查表格的布局方式是否正确。确保表格使...
不一致的条件格式 要解决不一致的条件格式问题,可以按照以下步骤进行:确定条件格式的规则:首先,需要明确条件格式的规则是...
Android|无法访问或保存... 这个问题可能是由于权限设置不正确导致的。您需要在应用程序清单文件中添加以下代码来请求适当的权限:此外...
【NI Multisim 14...   目录 序言 一、工具栏 🍊1.“标准”工具栏 🍊 2.视图工具...
银河麒麟V10SP1高级服务器... 银河麒麟高级服务器操作系统简介: 银河麒麟高级服务器操作系统V10是针对企业级关键业务...