百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

震惊!Swagger的这些属性你都忽略了吗?

yuyutoo 2024-10-12 01:49 2 浏览 0 评论


启用永久授权EnablePersistAuthorization

app.UseSwaggerUI(c =>
{
//指定Swagger JSON文件的终结点,用于加载和显示API文档。
//需要提供JSON文件的URL和一个可识别的名称
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");

//启用永久授权
c.EnablePersistAuthorization();
});

启用后,在登陆的小锁输入token之后,就可以 避免每次重新调试,再次输入token的问题,原理是swagger里面调用js代码来实现每次自动登录的

控制器XML注释

在实现xml注入的时候, options.IncludeXmlComments(xml,true); ,第二个属性控制是否为控控制器添加注释

public static class SwaggerSetup
{
public static IServiceCollection AddSwaggerSetup(this IServiceCollection services)
{

// 默认配置
Action<SwaggerGenOptions> defaultSetupAction = options =>
{
var basePath = AppContext.BaseDirectory;

options.SwaggerDoc("v1",
new OpenApiInfo
{
Title = "在线接口文档",
Version = "v1"
});

// 获取根目录下,所有 xml 完整路径(注:并不会获取二级目录下的文件)
var directoryInfo = new DirectoryInfo(basePath);
List<string> xmls = directoryInfo
.GetFiles()
.Where(f => f.Name.ToLower().EndsWith(".xml"))
.Select(f => f.FullName)
.ToList();

// 添加注释文档
foreach (var xml in xmls)
{
options.IncludeXmlComments(xml,true);
}

//tode 将默认扩展状态设置为 "none"

// 开启加权小锁
//options.OperationFilter<AuthenticationOperationFilter>();

// 开启加权小锁
//用于在 Swagger UI 的每个操作中添加 x-auth-token 响应头,以便在调用 API 后显示 token
//options.OperationFilter<AddResponseHeadersFilter>();
////用于将 "Authorize" 字符串添加到 Swagger UI 中每个操作的标题中,提醒用户该操作需要认证/授权才能访问
//options.OperationFilter<AppendAuthorizeToSummaryOperationFilter>();

//// 在 Swagger UI 的每个操作中添加一个 "Authorization" 按钮,并将认证令牌包含在请求头中
//options.OperationFilter<SecurityRequirementsOperationFilter>();

// 接入 Jwt 认证
//options.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
{
Scheme = "Bearer",
BearerFormat = "JWT",
Description = "在下面输入框输入Token",
Name = "Authorization",
In = ParameterLocation.Header,
Type = SecuritySchemeType.Http
});


};

// 注册 Swagger 并添加默认配置
services.AddSwaggerGen(defaultSetupAction);

// 如果有自定义配置
//if (setupAction != ) services.Configure(setupAction);

return services;
}

}

控制Try It Out请求的请求持续时间(以毫秒为单位)的显示

app.UseSwaggerUI(c =>
{
//指定Swagger JSON文件的终结点,用于加载和显示API文档。
//需要提供JSON文件的URL和一个可识别的名称
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");

//控制Try It Out请求的请求持续时间(以毫秒为单位)的显示
c.DisplayRequestDuration();
});

swagger ui的路由

app.UseSwaggerUI(c =>
{
//指定Swagger JSON文件的终结点,用于加载和显示API文档。
//需要提供JSON文件的URL和一个可识别的名称
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");

//指定swagger文档的启动目录 。默认为swagger
//可以通过设置为空字符串来让Swagger UI直接在根路径下进行访问
//c.RoutePrefix = string.Empty;

});

文档展开的方式

 //设置默认的接口文档展开方式,可选值包括None、List和Full。
//默认值为None,表示不展开接口文档;
//List表示只展开接口列表;
//Full表示展开所有接口详情
c.DocExpansion(DocExpansion.None); // 设置为完整模式
c.DisplayRequestDuration();
c.EnablePersistAuthorization();




相关推荐

史上最全的浏览器兼容性问题和解决方案

微信ID:WEB_wysj(点击关注)◎◎◎◎◎◎◎◎◎一┳═┻︻▄(页底留言开放,欢迎来吐槽)●●●...

平面设计基础知识_平面设计基础知识实验收获与总结
平面设计基础知识_平面设计基础知识实验收获与总结

CSS构造颜色,背景与图像1.使用span更好的控制文本中局部区域的文本:文本;2.使用display属性提供区块转变:display:inline(是内联的...

2025-02-21 16:01 yuyutoo

写作排版简单三步就行-工具篇_作文排版模板

和我们工作中日常word排版内部交流不同,这篇教程介绍的写作排版主要是用于“微信公众号、头条号”网络展示。写作展现的是我的思考,排版是让写作在网格上更好地展现。在写作上花费时间是有累积复利优势的,在排...

写一个2048的游戏_2048小游戏功能实现

1.创建HTML文件1.打开一个文本编辑器,例如Notepad++、SublimeText、VisualStudioCode等。2.将以下HTML代码复制并粘贴到文本编辑器中:html...

今天你穿“短袖”了吗?青岛最高23℃!接下来几天气温更刺激……

  最近的天气暖和得让很多小伙伴们喊“热”!!!  昨天的气温到底升得有多高呢?你家有没有榜上有名?...

CSS不规则卡片,纯CSS制作优惠券样式,CSS实现锯齿样式

之前也有写过CSS优惠券样式《CSS3径向渐变实现优惠券波浪造型》,这次再来温习一遍,并且将更为详细的讲解,从布局到具体样式说明,最后定义CSS变量,自定义主题颜色。布局...

柠檬科技肖勃飞:大数据风控助力信用社会建设

...

你的自我界限够强大吗?_你的自我界限够强大吗英文

我的结果:A、该设立新的界限...

行内元素与块级元素,以及区别_行内元素和块级元素有什么区别?

行内元素与块级元素首先,CSS规范规定,每个元素都有display属性,确定该元素的类型,每个元素都有默认的display值,分别为块级(block)、行内(inline)。块级元素:(以下列举比较常...

让“成都速度”跑得潇潇洒洒,地上地下共享轨交繁华
让“成都速度”跑得潇潇洒洒,地上地下共享轨交繁华

去年的两会期间,习近平总书记在参加人大会议四川代表团审议时,对治蜀兴川提出了明确要求,指明了前行方向,并带来了“祝四川人民的生活越来越安逸”的美好祝福。又是一年...

2025-02-21 16:00 yuyutoo

今年国家综合性消防救援队伍计划招录消防员15000名

记者24日从应急管理部获悉,国家综合性消防救援队伍2023年消防员招录工作已正式启动。今年共计划招录消防员15000名,其中高校应届毕业生5000名、退役士兵5000名、社会青年5000名。本次招录的...

一起盘点最新 Chrome v133 的5大主流特性 ?

1.CSS的高级attr()方法CSSattr()函数是CSSLevel5中用于检索DOM元素的属性值并将其用于CSS属性值,类似于var()函数替换自定义属性值的方式。...

竞走团体世锦赛5月太仓举行 世界冠军杨家玉担任形象大使

style="text-align:center;"data-mce-style="text-align:...

学物理能做什么?_学物理能做什么 卢昌海

作者:曹则贤中国科学院物理研究所原标题:《物理学:ASourceofPowerforMan》在2006年中央电视台《对话》栏目的某期节目中,主持人问过我一个的问题:“学物理的人,如果日后不...

你不知道的关于这只眯眼兔的6个小秘密
你不知道的关于这只眯眼兔的6个小秘密

在你们忙着给熊本君做表情包的时候,要知道,最先在网络上引起轰动的可是这只脸上只有两条缝的兔子——兔斯基。今年,它更是迎来了自己的10岁生日。①关于德艺双馨“老艺...

2025-02-21 16:00 yuyutoo

取消回复欢迎 发表评论: