C# .net core WebApi Swagger配置

news/2024/5/19 23:43:32 标签: c#, .netcore

一. 支持注释

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.niftyadmin.cn/n/5330153.html

相关文章

【Tricore】基于主流芯片, 浅谈ECU多核架构与“核间通信”

文章目录 概要 整体架构 简单聊聊什么是多核架构和“核间通信”

Vue加载序列帧动图

解读方法 使用<img :src"currentFrame" alt"加载中" /> 加载图片动态更改src的值使用 requestAnimationFrame 定时更新在需要的页面调用封装的组件 <LoadToast v-if"showLoading" /> 封装组件 <template><div class"…

保送阿里云的云原生学习路线

近期好多人都有咨询学习云原生有什么资料。与其说提供资料不如先说一说应该如何学习云原生。 Linux基础知识&#xff1a;云原生技术通常在Linux环境中运行&#xff0c;因此建议首先掌握Linux的基础知识&#xff0c;包括命令行操作、文件系统、权限管理等。 容器化技术&#x…

目标检测DETR:End-to-End Object Detection with Transformers

NMS 对一个目标生成了多个检测窗口&#xff0c;但是事实上这些窗口中大部分内容都是重复的&#xff0c;找到目标检测最优的窗口 选取多个检测窗口中分数最高的窗口&#xff0c;剔除掉其他同类型的窗口 anchor generator 首先在该点生成scale512, aspect ratio{1:2&#xff…

UE5 简易MC教程学习心得

https://www.bilibili.com/video/BV12G411J7hV?p13&spm_id_frompageDriver&vd_sourceab35b4ab4f3968642ce6c3f773f85138 ———— 目录 0.摧毁逻辑学习 1.发光材质灯方块 2.封装。想让子类 不更改父类的变量。 3.材质命名习惯。 0.摧毁逻辑学习 达到摧毁的条件…

聚合收益协议 InsFi :打开铭文赛道全新叙事的旋转门

​“InsFi 协议构建了一套以铭文资产为基础的聚合收益体系&#xff0c;该体系正在为铭文资产捕获流动性、释放价值提供基础&#xff0c;该生态也正在成为铭文赛道掘金的新热土。” 在 2023 年年初&#xff0c;Ordinals 协议在比特币链上被推出后&#xff0c;为比特币链上带来了…

GPT获取session token

这里写自定义目录标题 概述通过浏览器获取session token通过ChatGPT网页获取session token 概述 ChatGPT是一种基于人工智能的对话模型&#xff0c;由OpenAI开发。通过使用ChatGPT的API&#xff0c;用户可以实现智能对话的功能。这篇文章将介绍如何获取ChatGPT Session Token以…

中国HTCC高温共烧陶瓷行业调研与预测报告(2024版)

内容介绍&#xff1a; 高温共烧陶瓷&#xff0c;英文简称为HTCC&#xff08;HighTemperatureco-firedCeramic&#xff09;&#xff0c;采用材料为W、Mo、Mn、Mo-Mn等金属&#xff08;主要为高熔点&#xff09;发热电阻浆料按照发热电路设计的要求印刷在Al2Q3/AlN/莫来石&#…