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

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

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...