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

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

yuyutoo 2024-10-12 01:49 7 浏览 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();




相关推荐

墨尔本一华裔男子与亚裔男子分别失踪数日 警方寻人

中新网5月15日电据澳洲新快网报道,据澳大利亚维州警察局网站消息,22岁的华裔男子邓跃(Yue‘Peter’Deng,音译)失踪已6天,维州警方于当地时间13日发布寻人通告,寻求公众协助寻找邓跃。华...

网络交友须谨慎!美国犹他州一男子因涉嫌杀害女网友被捕

伊森·洪克斯克(图源网络,侵删)据美国广播公司(ABC)25日报道,美国犹他州一名男子于24日因涉嫌谋杀被捕。警方表示,这名男子主动告知警局,称其杀害了一名在网络交友软件上认识的25岁女子。雷顿警...

一课译词:来龙去脉(来龙去脉 的意思解释)

Mountainranges[Photo/SIPA]“来龙去脉”,汉语成语,本指山脉的走势和去向,现比喻一件事的前因后果(causeandeffectofanevent),可以翻译为“i...

高考重要考点:range(range高考用法)

range可以用作动词,也可以用作名词,含义特别多,在阅读理解中出现的频率很高,还经常作为完形填空的选项,而且在作文中使用是非常好的高级词汇。...

C++20 Ranges:现代范围操作(现代c++白皮书)

1.引言:C++20Ranges库简介C++20引入的Ranges库是C++标准库的重要更新,旨在提供更现代化、表达力更强的方式来处理数据序列(范围,range)。Ranges库基于...

学习VBA,报表做到飞 第二章 数组 2.4 Filter函数

第二章数组2.4Filter函数Filter函数功能与autofilter函数类似,它对一个一维数组进行筛选,返回一个从0开始的数组。...

VBA学习笔记:数组:数组相关函数—Split,Join

Split拆分字符串函数,语法Split(expression,字符,Limit,compare),第1参数为必写,后面3个参数都是可选项。Expression为需要拆分的数据,“字符”就是以哪个字...

VBA如何自定义序列,学会这些方法,让你工作更轻松

No.1在Excel中,自定义序列是一种快速填表机制,如何有效地利用这个方法,可以大大增加工作效率。通常在操作工作表的时候,可能会输入一些很有序的序列,如果一一录入就显得十分笨拙。Excel给出了一种...

Excel VBA入门教程1.3 数组基础(vba数组详解)

1.3数组使用数组和对象时,也要声明,这里说下数组的声明:'确定范围的数组,可以存储b-a+1个数,a、b为整数Dim数组名称(aTob)As数据类型Dimarr...

远程网络调试工具百宝箱-MobaXterm

MobaXterm是一个功能强大的远程网络工具百宝箱,它将所有重要的远程网络工具(SSH、Telnet、X11、RDP、VNC、FTP、MOSH、Serial等)和Unix命令(bash、ls、cat...

AREX:携程新一代自动化回归测试工具的设计与实现

一、背景随着携程机票BU业务规模的不断提高,业务系统日趋复杂,各种问题和挑战也随之而来。对于研发测试团队,面临着各种效能困境,包括业务复杂度高、数据构造工作量大、回归测试全量回归、沟通成本高、测试用例...

Windows、Android、IOS、Web自动化工具选择策略

Windows平台中应用UI自动化测试解决方案AutoIT是开源工具,该工具识别windows的标准控件效果不错,但是当它遇到应用中非标准控件定义的UI元素时往往就无能为力了,这个时候选择silkte...

python自动化工具:pywinauto(python快速上手 自动化)

简介Pywinauto是完全由Python构建的一个模块,可以用于自动化Windows上的GUI应用程序。同时,它支持鼠标、键盘操作,在元素控件树较复杂的界面,可以辅助我们完成自动化操作。我在...

时下最火的 Airtest 如何测试手机 APP?

引言Airtest是网易出品的一款基于图像识别的自动化测试工具,主要应用在手机APP和游戏的测试。一旦使用了这个工具进行APP的自动化,你就会发现自动化测试原来是如此简单!!连接手机要进行...

【推荐】7个最强Appium替代工具,移动App自动化测试必备!

在移动应用开发日益火爆的今天,自动化测试成为了确保应用质量和用户体验的关键环节。Appium作为一款广泛应用的移动应用自动化测试工具,为测试人员所熟知。然而,在不同的测试场景和需求下,还有许多其他优...

取消回复欢迎 发表评论: