不要在Swashbuckle(Swagger)中显示端点。
创始人
2025-01-11 04:32:14
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。

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

相关内容

热门资讯

安卓换鸿蒙系统会卡吗,体验流畅... 最近手机圈可是热闹非凡呢!不少安卓用户都在议论纷纷,说鸿蒙系统要来啦!那么,安卓手机换上鸿蒙系统后,...
安卓系统拦截短信在哪,安卓系统... 你是不是也遇到了这种情况:手机里突然冒出了很多垃圾短信,烦不胜烦?别急,今天就来教你怎么在安卓系统里...
app安卓系统登录不了,解锁登... 最近是不是你也遇到了这样的烦恼:手机里那个心爱的APP,突然就登录不上了?别急,让我来帮你一步步排查...
安卓系统要维护多久,安卓系统维... 你有没有想过,你的安卓手机里那个陪伴你度过了无数日夜的安卓系统,它究竟要陪伴你多久呢?这个问题,估计...
windows官网系统多少钱 Windows官网系统价格一览:了解正版Windows的购买成本Windows 11官方价格解析微软...
安卓系统如何卸载app,轻松掌... 手机里的App越来越多,是不是感觉内存不够用了?别急,今天就来教你怎么轻松卸载安卓系统里的App,让...
怎么复制照片安卓系统,操作步骤... 亲爱的手机控们,是不是有时候想把自己的手机照片分享给朋友,或者备份到电脑上呢?别急,今天就来教你怎么...
安卓系统应用怎么重装,安卓应用... 手机里的安卓应用突然罢工了,是不是让你头疼不已?别急,今天就来手把手教你如何重装安卓系统应用,让你的...
iwatch怎么连接安卓系统,... 你有没有想过,那款时尚又实用的iWatch,竟然只能和iPhone好上好?别急,今天就来给你揭秘,怎...
安装了Anaconda之后找不... 在安装Anaconda后,如果找不到Jupyter Notebook,可以尝试以下解决方法:检查环境...