首页 > 其他分享 >配置 Swagger + 注释

配置 Swagger + 注释

时间:2024-07-01 09:41:38浏览次数:15  
标签:xml OpenApiSecurityScheme Bearer 配置 注释 new Swagger

打开Xml文件生成,右键项目进入属性设置:

 取消未进行注释而进行提示的警告:

 然后Program.cs增加代码:

 代码:

builder.Services.AddSwaggerGen(s =>
{
    //获取xml文件名称
    var xmlFileName = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    //包含注释,第二个参数表示是否显示控制器注释
    s.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFileName), true);
    //添加安全定义
    s.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
    {
        Description = "请输入token,格式为 Bearer xxxxxxxx(注意中间必须有空格)",
        Name = "Authorization",
        In = ParameterLocation.Header,
        Type = SecuritySchemeType.ApiKey,
        BearerFormat = "JWT",
        Scheme = "Bearer"
    });
    //添加安全要求
    s.AddSecurityRequirement(new OpenApiSecurityRequirement {
        {
            new OpenApiSecurityScheme{
                Reference =new OpenApiReference{
                    Type = ReferenceType.SecurityScheme,
                    Id ="Bearer"
                }
            },new string[]{ }
        }
    });
});

 

标签:xml,OpenApiSecurityScheme,Bearer,配置,注释,new,Swagger
From: https://www.cnblogs.com/zzgxl/p/18277438

相关文章

  • Linux和windows网络配置文件的修改
    Linux和windows网络配置文件的修改网络配置文件是计算机网络管理中至关重要的一部分。正确配置网络文件可以确保计算机与网络设备之间的通信顺畅,避免网络故障。本文将详细介绍网络配置文件的修改方法,包括常见命令、使用方法举例,以及一些优化建议。一、网络配置文件概述网......
  • 详述Python环境下配置AI大模型Qwen-72B的步骤
    随着人工智能技术的发展,大规模预训练模型如Qwen-72B等逐渐成为研究和应用的重点。本篇博客旨在提供一份详细的指南,帮助Python开发者们在自己的环境中顺利配置并使用Qwen-72B大模型。请注意:由于Qwen-72B这一模型目前并未公开存在,所以以下内容仅为假设性描述,实际上你需要替换为......
  • SpringMVC配置文件的位置和命名
    配置web.xml文件时我们需要配置SpringMVC框架的配置文件,该文件有两种配置方式。第一种是默认配置,第二种是带配置参数的配置。1.1默认配置方式SpringMVC框架有它自己的配置文件,该配置文件的名字默认为:-servlet.xml,默认存放的位置是WEB-INF目录下。如果采用这种方式意味着文件的......
  • Nginx的概述和配置
    Nginx的概述和配置目录Nginx的概述和配置一、Nginx概述1、Nginx是什么2、Nginx的特点:3、Nginx和Apache的区别3.1nginx相对于apache的优点∶3.2apache相对于nginx的优点∶4、nginx的两种进程分别有什么作用二、编译安装nginx1、关闭防火墙2、将所需的安装包放到/data下,并解压3、......
  • 猫头虎分享已解决Bug || 服务器配置错误(Server Configuration Error): ServerMisconfig
    ......
  • 【Redis —— 04 Redis配置文件】
    Redis配置文件(通常为redis.conf)包含多种配置选项,可以调整Redis服务器的行为和性能。以下是Redis配置文件中的常见配置项及其详解:官网:Redisconfiguration|Docs常用配置项1.基本配置bind绑定的IP地址。如果你想让Redis监听多个IP地址,可以用空格分隔多个IP。示例:b......
  • 【Redis —— 06 主从复制配置】
    Redis主从复制(replication)允许一个Redis服务器(称为主服务器)将数据复制到一个或多个Redis服务器(称为从服务器)。这种机制可以用于提高数据的可用性和分布式读取能力。以下是配置Redis主从复制的步骤:主服务器配置在主服务器上,通常不需要进行特殊配置,只需确保Redis服......
  • 41、linux-yum源管理-阿里云仓库配置
    ·yum的管理1、清理原有的yum配置·把本地或者官方的/etc/yum.repos.d/路径下的所有repo配置文件移走·确保/etc/yum.repos.d/这里没有其它文件2、下载配置阿里巴巴开源镜像站官网配置:https://developer.aliyun.com/mirror/·在这个位置/e......
  • Qt下载安装及配置教程
    文章目录1. QT简介2. 下载QT3.检查配置环境4.创建QT项目1. QT简介Qt是一个跨平台C++图形用户界面(GUI)工具包,它由Qt公司(前身为Trolltech)开发和维护。自1995年发布以来,Qt因其强大的功能和跨平台能力,成为了许多软件开发者的首选工具。无论是在桌面应用程序、移动应用......
  • Linux-如何查看服务器中的硬件配置信息
    在Linux服务器上查看硬件配置信息,可以使用一系列命令行工具。以下是一些常用命令来获取不同硬件组件的详细信息:查看CPU信息:查看内存信息:cat/proc/cpuinfo:显示处理器类型、型号、频率、核心数等详细信息。lscpu:提供更为人性化的CPU架构和核心数量等信息。查看硬盘信息: ......