C# .net core WebApi Swagger配置

news2024/11/18 5:53:31

一. 支持注释

1.首先进行项目的创建,我这边以.net 7 为例来进行解说,因为.net 7中没有startup.cs文件,startup.cs文件已与program.cs文件进行了合并,我们来配置program.cs文件来让Swagger文档支持控制器的注释以及操作方法的注释

进入program.cs文件 里面会显示此配置,我们将此配置进行更换为下面的代码配置
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
#region Swagger的配置
builder.Services.AddEndpointsApiExplorer();
    builder.Services.AddSwaggerGen(option=>
    {
        // xml文档绝对路径--读取根据控制器api生成的Xml的文件
         var file = Path.Combine(AppContext.BaseDirectory,"ReadingPlatForm.xml");
        // true : 显示控制器层注释
        option.IncludeXmlComments(file, true);
        // 对option的名称进行排序,如果有多个,就可以看见效果了。
        option.OrderActionsBy(o => o.RelativePath);
    });
#endregion

配置完成后,右键项目文件夹=》属性,勾选生成包含API文档的文件,勾选完毕后重新生成解决方案,即可在项目的DeBug目录下 可以查看到 ReadingPlatForm.xml这个配置文件(这个文件的名称 最好以项目名称进行命名),此时启动项目,则可以看到控制器和操作方法带有自己书写的注释
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1386310.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

TabLayout去除点击时的波纹效果

需求:去除com.google.android.material.tabs.TabLayout手指点击时产生的波纹效果 解决办法: xml中增加 app:tabBackground"null" app:tabRippleColor"null" 注意:Java/kotlin代码中不要设置这两个属性了。

IOS自动化测试元素定位

一、元素属性介绍 1、元素属性 2、查看各定位方式执行效率 二、iOS常用定位方法 1、accessibility_id 2、class_name 3、Xpath 4、ios_class_chain(类型链) 5、ios_predicate(谓词) 一个页面最基本组成单元是元素,想要定位一个元素,我们需…

线性表 | 双向链表

双向链表 双向循环链表

定制聚四氟乙烯反应容器可配套温度计套管和冷凝管

是谁遇到氟化氢就头疼,是谁看着玻璃装置被强碱性试剂折腾的惨不忍睹。 特氟龙塑料材质可以帮您解决问题,聚四氟乙烯材质是其中的一种材质,耐温250℃,耐受强酸强碱和各种有机溶剂,加工灵活,来样或者图纸或者…

使用WAF防御网络上的隐蔽威胁之SSRF攻击

服务器端请求伪造(SSRF)攻击是一种常见的网络安全威胁,它允许攻击者诱使服务器执行恶意请求。与跨站请求伪造(CSRF)相比,SSRF攻击针对的是服务器而不是用户。了解SSRF攻击的工作原理、如何防御它&#xff0…

数据结构之str类

str类 str 是字符串类。str 大概是 Python 中除了int 之外最基本、最常用的数据类型,在Java与其他语言里基本叫做String,其用途广泛,随处可见,但是要记住一点,字符串是不允许修改的。不过,我们仍然可以对其…

org.springframework.web.servlet.HandlerInterceptor

过期 1 配置黑名单 2 启动注册拦截 3 浏览器访问拦截

Linux CentOS 7.6安装nginx详细保姆级教程

一、通过wget下载nginx压缩包 1、进入home文件并创建nginx文件夹用来存放nginx压缩包 cd /home //进入home文件夹 mkdir nginx //创建nginx文件夹 cd nginx //进入nginx文件夹2、下载nginx,我这里下载的是Nginx 1.24.0版本,如果要下载新版本可以去官网进行下载:…

【Dart】=> [06] Dart初体验-类Class-构造函数-继承-mixin-异步编程-链式调用-泛型-异常

目录 能够定义并使用Dart的类类的定义构造函数私有属性和方法继承mixin异步编程FutureFuture链式调用async - awaitdynamic类型泛型异常 能够定义并使用Dart的类 Dart是一门面向对象的编程语言,所有的对象都是类的实例 通过类我们可以对数据和方法进行封装复用 学习…

JVM基础(8)——CMS垃圾回收器

作者简介:大家好,我是smart哥,前中兴通讯、美团架构师,现某互联网公司CTO 联系qq:184480602,加我进群,大家一起学习,一起进步,一起对抗互联网寒冬 学习必须往深处挖&…

企业销售人员都在用的客户管理CRM软件有哪些?

“目前我公司需要用到软件的人数不超过10个,主要销售模式是电话、拜访为主,产品是称重设备,客户是工厂。” 上面的需求整理了一下: 团队规模:小规模,不超过10人——尽可能降低使用成本使用人员:…

C++结合OpenCV:图像的加法运算

一、图像运算 针对图像的加法运算、位运算都是比较基础的运算。但是,很多复杂的图像处理功能正是借助这些基础的运算来完成的。所以,牢固掌握基础操作,对于更好地实现图像处理是非常有帮助的。本章简单介绍了加法运算、位运算,并…

CG Magic分享3dmax渲染太亮问题如何解决?

3D Max软件渲染时,渲染问题较多也是正常的,对于行业小白来说,渲染问题多也是能理解的,因为,小编经常在问答中,看到一些网友提问,3dmax渲染太亮怎么办? 3dmax渲染太亮了怎么回事&…

如何定位和优化程序CPU、内存等性能之巅

摘要 性能优化指在不影响系统运行正确性的前提下,使之运行得更快,完成特定功能所需的时间更短,或拥有更强大的服务能力。本文将介绍性能优化的基本概念以及如何定位和优化程序中的CPU、内存和IO瓶颈。 引言 随着计算机系统的日益复杂和应用…

有哪些windows录屏软件?

有哪些windows录屏软件?随着技术的发展,使用Windows录屏软件已成为一种非常方便的方式,可以帮助人们记录和分享他们在计算机上的操作过程。例如,您可以使用录屏软件记录您在编辑文档或演示新产品时的屏幕操作,并将其用…

BIOS知识枝桠——RAID 磁盘阵列

文章目录 前言一、RAID介绍二、RAID等级分类1.RAID02.RAID13.RAID24.RAID3和RAID45.RAID5和RAID66.RAID77.RAID10 BIOS下组建RAID 前言 假设存在多块磁盘,如果不组建阵列,磁盘与磁盘之间是没有任何关系的。磁盘A和B,放在A中的文件与B磁盘没有…

自学Python笔记总结(更新中……)

自学Python笔记总结 网址数据类型类型查看类型,使用type内置类标识符 输出输入语句format函数的语法及用法数据类型的转换运算符算数运算符赋值运算符的特殊场景拆包 比较运算符逻辑运算符 与 短路位运算符运算符优先级 程序流程控制分支语句pass 占位 循环语句 whi…

可应用于电脑主板等产品上的精密基准电路WL431 输出电压可设定 响应速度快

WL431为三端可调节精密基准源。通过两个外接电阻,输出电压可在Vref约2.5 V )到36V连续调节。该电路输出阻抗小(0.2Q)。 开启特性好,在许多应用场合,它能较好地替换齐纳极管。 主要特点:● 温度系数 50pmC ● 在…

荣耀开发者大会2023 · 一张图读懂智慧人机交互分论坛

荣耀智慧人机交互,以用户意图理解为主的智慧交互,平台级AI使能主动理解用户意图,服务找人能力全面升级! 荣耀智慧门能精准理解用户交互意图,覆盖100头部应用,支持文本、图片等元素类型随心拖拽&#xff0c…