首页 > 其他分享 >NETCORE - Swagger配置

NETCORE - Swagger配置

时间:2023-05-29 15:55:12浏览次数:49  
标签:requirement NETCORE app 配置 var new Swagger Authorization

NETCORE - Swagger配置

 环境:WebApi NET6 

 

配置输出文档,项目右键-> 属性 -> 生成 -> 输出 

勾选 “生成包含API文档的文件”

维护生成文件名称。

 

 2. Program.cs 中的修改

把原来的 

builder.Services.AddSwaggerGen();

 

 修改成:

builder.Services.AddSwaggerGen(c =>
{
    //Authorization 鉴权
    var scheme = new OpenApiSecurityScheme()
    {
        Description = "Authorization header. \r\nExample: 'Bearer abcdefxxx'",
        Reference = new OpenApiReference
        {
            Type = ReferenceType.SecurityScheme,
            Id = "Authorization"
        },
        Scheme = "oauth2",
        Name = "Authorization",
        In = ParameterLocation.Header,
        Type = SecuritySchemeType.ApiKey,
    };
    c.AddSecurityDefinition("Authorization", scheme);
    var requirement = new OpenApiSecurityRequirement();
    requirement[scheme] = new List<string>();
    c.AddSecurityRequirement(requirement);

    //中文注释
    var basePath = Path.GetDirectoryName(AppContext.BaseDirectory);
    c.IncludeXmlComments(Path.Combine(basePath, "swap.xml"), true);
});

 

 

此时已增加了 鉴权 与注释

 

项目中 webapi 的类与接口需增加注释

 

 

 

项目发布后需要查看swagger时,需修改Program.cs里面的

if (app.Environment.IsDevelopment())
{
}
app.UseSwagger();
app.UseSwaggerUI();

 

  

 

 

 

 

 

 

参考:https://www.cnblogs.com/chenwolong/p/swger.html

完成!

标签:requirement,NETCORE,app,配置,var,new,Swagger,Authorization
From: https://www.cnblogs.com/1285026182YUAN/p/17440635.html

相关文章

  • 独角数卡 搭建-邮件配置-Epusdt配置-收U详细配置
    配置独角数卡https://github.com/assimon/dujiaoka/wiki/2.x_bt_install⚠️正式上线后一定要将.env配置里面的APP_DEBUG设置为false⚠️⚠️正式上线后一定要将.env配置里面的APP_DEBUG设置为false⚠️⚠️正式上线后一定要将.env配置里面的APP_DEBUG设置为false⚠️安装宝塔(国际版宝塔:a......
  • docker-oracle;配置oracle
    地址:172.18.0.170root/cssjkyhs/yhs0527le一、安装检查uname-r:查看centos版本,root登录,如果不是root,需要前面加sudo如果之前有安装,卸载:yumremovedockerdocker-commondocker-selinuxdocker-engine二、安装docker安装需要的软件包,yum-util提供......
  • Mybatis Generator 配置详解
    因原版观感不佳,搬运至此。作者:Jimin链接:https://www.imooc.com/article/21444来源:慕课网<?xmlversion="1.0"encoding="UTF-8"?><!DOCTYPEgeneratorConfiguration PUBLIC"-//mybatis.org//DTDMyBatisGeneratorConfiguration1.0//EN"&quo......
  • vm - centos 配置好后还是网络不通-解决
    1.背景这不是linux系统问题,是vm没有配置好导致2.解决打开目的实例的设置》网络适配器 换为配好的虚拟网卡同时保证win系统开启这个网卡 然后重启虚拟机3.测试cmdping一下 好了,现在可以使用xshell来连接了 ......
  • 详谈Java中Properties配置类怎么用
    本文将为大家详细讲解Java中Properties配置类怎么用,这是我们进行开发时经常用到的知识点,也是大家在学习Java中很重要的一个知识点,更是我们在面试时有可能会问到的问题!文章较长,干货满满,建议大家收藏慢慢学习。文末有本文重点总结,主页有全系列文章分享。技术类问题,欢迎大家和我们一......
  • SpringBoot自动配置原理
    在SpringBoot项目中的引导类上有一个注解@SpringBootApplication,这个注解是对三个注解进行了封装,分别是:@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan其中@EnableAutoConfiguration是实现自动化配置的核心注解。该注解通过@Import注解导入对应的配......
  • 基于注解的Spring AOP的配置和使用
    AOP是OOP的延续,是AspectOrientedProgramming的缩写,意思是面向切面编程。可以通过预编译方式和运行期动态代理实现在不修改源代码的情况下给程序动态统一添加功能的一种技术。AOP实际是GoF设计模式的延续,设计模式孜孜不倦追求的是调用者和被调用者之间的解耦,AOP可以说也是这种目标......
  • macos环境配置相关记录
    macos环境配置相关记录本人的终端shell为zsh、所有的环境配置在~/.zshrc中进行、最后不要忘记source  ~/.zshrc 服务端类的程序如TomcatNGINX之类的、一律放在/Library目录下如果是插件之类的、如gradle、maven之类的、一律安装在/opt/对应的目录下......
  • MySQL主从复制验证性配置操作
    前置条件:VMwareWorkstationPro、CentOS7两台同网段虚机dw2(ip:192.168.203.202),dw3(ip:192.168.203.203)1.数据库安装和初始化yuminstall-ymariadbmariadb-servermariadb-develvim/etc/my.cnf#打开mysql-bin功能[mysqld]server-id=2log-bin=mysql-bin#启动marid......
  • nginx,gateway配置
    反向代理:监听192.168.10.129:9001如果url中有edu就把请求转发给http://ip1:port1,如果url中有vod就把请求转发给http://ip2:port2nginx配置:server{listen9001;server_name192.168.10.129;location~/edu/{proxy_passhttp://ip1:port1}location~/vod/{proxy_passhtt......