【.net core】获取或排除指定控制器的 Swagger 文档配置

news/2024/5/20 0:07:52 标签: .netcore

前言

在api接口开发完成后,我们经常会使用swagger文档配置来查看相关接口信息,有时候也会查看指定某个控制器来生成swagger文档,或是排除某些控制器等操作,如下为示例

获取指定控制器 

 // Register the Swagger services
            services.AddSwaggerDocument(config =>
            {
                config.Title = GetType().Namespace;
                
                config.PostProcess = document =>
                {
                    // 获取指定控制器的文档配置
                    var filteredControllers = new List<string> { "控制器名称" };
                    var pathsToKeep = document.Paths
                        .Where(p => filteredControllers.Contains(p.Key.Split('/')[2])) // 需要保留的控制器路径
                        .ToDictionary(p => p.Key, p => p.Value);

                    document.Paths.Clear();
                    foreach (var path in pathsToKeep)
                    {
                        document.Paths.Add(path.Key, path.Value);
                    }
                };
            });

排除指定控制器

services.AddSwaggerDocument(config =>
{
    // Swagger 文档配置

    config.PostProcess = document =>
    {
        // 过滤控制器
        var filteredControllers = new List<string> { "指定的控制器名称1", "指定的控制器名称2" };
        var pathsToRemove = document.Paths
            .Where(p => !filteredControllers.Contains(p.Key.Split('/')[2])) // 需要过滤的控制器路径
            .ToList();

        foreach (var path in pathsToRemove)
        {
            document.Paths.Remove(path.Key);
        }
    };

    // 其他配置项
});


http://www.niftyadmin.cn/n/1007422.html

相关文章

Python语法中字典有哪些作用?举例说明

1、存储配置信息&#xff1a; config {database: mydb,username: admin,password: 123456 }可以使用字典来存储应用程序的配置信息&#xff0c;方便进行访问和修改。 2、缓存数据&#xff1a; cache {user1: {name: John, age: 25},user2: {name: Alice, age: 30} }3、字典…

linux登录百度网盘下载上传文件

这里写自定义目录标题 linux登录百度网盘下载上传文件 linux登录百度网盘下载上传文件 参考一下的三个地址&#xff1a; 1.https://blog.csdn.net/huojiahui22/article/details/128897977 2.https://www.jianshu.com/p/5a50370f1d1e 3.https://blog.csdn.net/RayChiu757374816…

CUGBACM21级暑假专题训练#6 字符串

训练链接 A - 剪花布条 一块花布条&#xff0c;里面有些图案&#xff0c;另有一块直接可用的小饰条&#xff0c;里面也有一些图案。对于给定的花布条和小饰条&#xff0c;计算一下能从花布条中尽可能剪出几块小饰条来呢&#xff1f; Input 输入中含有一些数据&#xff0c;分别…

javac命令编译.java源文件报错“编码GBK的不可映射字符“

原因在于.java源文件编码方式是UTF-8 二cmd DOS窗口编码格式是GBK 解决办法 javac -encoding UTF-8 *.java

vector 容器初始化(1维,2维等)

C中容器vector非常常见&#xff0c;有时候需要事先定义其容器的长度&#xff0c;其中包括一维、二维容器长度的定义&#xff0c;其中二维容器定义可以用于存储二维数组&#xff0c;用于点云数据组织&#xff0c;分块处理等&#xff0c;下面分别介绍一维与二维容器的初始化。 1…

算法刷题Day 23 修剪二叉搜索树+将有序数组转换为二叉搜索树+把二叉搜索树转换为累加树

Day 23 二叉树 669. 修剪二叉搜索树 递归 好神奇&#xff0c;完全凭感觉写&#xff0c;感觉应该过不了&#xff0c;结果就过了 class Solution { public:TreeNode* trimBST(TreeNode* root, int low, int high) {if (!root) return nullptr;if (root->val < low){ret…

什么是文件存储、对象存储、块存储?

什么是文件存储 文件存储带有文件系统&#xff0c;主要是以文件的形式存放数据&#xff0c;能将所有的目录、文件形成一个有层次的树形结构来管理&#xff0c;通过“树”不断伸展的枝丫就能找到你需要的文件。存储协议主要是NFS、CIFS等&#xff0c;以统一命名空间的形式共享一…

Nacos报9848

问题&#xff1a; Connection refused: no further information: localhost/0:0:0:0:0:0:0:1:9848 解决&#xff1a; 这里是springboot集成springcloud后&#xff0c;把application.yml改成bootstrap.yml就可以了&#xff0c;不然读取不到nacos配置。