tnblog
首页
视频
资源
登录

ABP Xml为Swagger接口页添加详细注释

5959人阅读 2021/8/31 18:41 总访问:1593155 评论:0 收藏:0 手机
分类: ABP
  1. 我们选中我们Application层的项目,右键属性,勾选为Xml生成文档,如下图所示。

  2. 在你的 项目名.Web.Host startup目录下,找到StartUp.cs类,在它的ConfigureServices方法中,找到services.AddSwaggerGen 方法,将生成的Xml配置进去。核心代码如下:


    方法1.// Set the comments path for the Swagger JSON and UI.

    //路径,路径为XML文档文件路径去玩后的名称

     var xmlFile = @"SCBC.SMES.Application.xml";

     var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);

     options.IncludeXmlComments(xmlPath,true);

    方法二.// 为 Swagger JSON and UI设置xml文档注释路径

      var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录(绝对,不受工作目录影响,建议采用此方法获取路径)

     var xmlPath1 = Path.Combine(basePath, "Myprop.Application.xml");//这个就是应用层配置的xml文件名

     options.IncludeXmlComments(xmlPath1, true);

     var xmlPath2 = Path.Combine(basePath, "Myprop.Core.xml");//这个就是给领域层配置的xml文件名

 options.IncludeXmlComments(xmlPath2, true);



评价

数据读取器与指定的"xx"不兼容。某个类型"xx"的成员在同名的数据读取器中没有对应的列

报错的地方var result= _db.Database.SqlQuery<SMachine>(sql).FirstOrDefault();经过分析,是因为SqlQuery方法查询...

我们何要接吻【阅读听力】

英语不能丢,音频后面传People kiss for the simple reason that it feels good. Our lips are full of sensitive nerve en...

图解什么你学得越多反而觉得不知道的越多

所以其实是你的视野更广了,站的高度更高了看得更远了

大脑何有那么多沟壑【阅读听力】

Why The Brain Has So Many Folds"Dear A Moment of Science, I know the human brain is an incredible thing, the m...

什么要使用webapi而不直接使用controller

彼年豆蔻,谁许谁地老天荒。webapi能做的事情,controller都能做,为什么要使用webapi而不直接使用controller呢?这就好比...

没有 SQL 缓存通知启用数据库

C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\aspnet_regsql -S 数据库IP -U 登录名 -P 密码 -d 数据库名称 -t 表名 -et

jQuery—动态添加的元素绑定事件

我们在使用jQuery的时候总会遇到形形色色的问题在jQuery的元素绑定事件中,我通常使用click来绑定单击事件,但是这个只能绑...

code first执行命令报错,无法将“Enable-Migrations”项识别 cmdlet、函数、脚本文件

EF:执行命令报错无法将“Enable-Migrations”项识别为 cmdlet、函数、脚本文件或可运行程序的名称。请检查名称的拼写,如...

基于office 把wordwordxpptpptxxlsxlsx转pdf在线预览

//,要在服务器安装office,需要引用usingMicrosoft.Office.Interop.Word;usingMicrosoft.Office.Interop.PowerPoint;usingMi...

基于open office 把各种类型转pdf在线预览

//需要在服务器安装openoffice,引用cli_basetypes,cli_cppuhelper,cli_oootypes,cli_ure,cli_uretypes publicboolCon...

检索 COM 类工厂中 CLSID {000209FF-0000-0000-C000-000000000046} 的组件时失败,原因是出现以下错误: 80070005 拒绝访问

最近在做一个关于word,ppt,Excel在线预览的功能,期间出现了几个问题,也不算棘手,但是对于第一次使用office组件的人来...

手机连接电脑

首先开启use调试:系统-->关于手机-->在版本号点击5次就可以开启开发者模式然后在系统菜单里边就多出来:开发人员选...

html转换js,节省重复模块的编写时间

有些时候,我们需要多次应用到自己的布局块,我们可以通过将html代码装换成js文件来装取代码下次需要用到时,去引入对应的j...

什么需要服务注册与服务发现

我的理解:就是服务于服务之间不直接依赖,而是通过注册中心来管理。就类似依赖注入一样,类与类之间不支持依赖,而是通过...
没有个性,不需要签名
排名
4
文章
473
粉丝
3
评论
2
ICP备案 :渝ICP备18016597号-1
网站信息:2018-2025TNBLOG.NET
技术交流:群号656732739
联系我们:contact@tnblog.net
公网安备:50010702506256
欢迎加群交流技术