2023年7月18日发(作者:)
Abp为Swagger接⼝页添加详细注释 从Abp官⽹创建完项⽬之后,启动之后,Swagger的接⼝说明页,默认是没有接⼝说明的,这样是很不友好的,也不利于接⼝调⽤者的使⽤,所以,我们要实现Swagger页⾯的接⼝注释功能。 ⾸先,我们看⼀下默认启动后,Swagger的接⼝页⾯,标红的是我们⾃⼰写的获取所有组织机构的接⼝,默认是没有注释的。
接下来,我们选中我们Application层的项⽬,右键“属性”,将输出路径选择为“binDebug”,然后再勾选为Xml⽣成⽂档,如下图所⽰。接下来,在你的 项⽬名. 的startup⽬录下,找到类,在它的ConfigureServices⽅法中,找到配置Swagger的代码块(ggerGen),将⽣成的Xml配置进去。核⼼代码如下: var basePath = ectoryName(typeof(Program).on);//获取应⽤程序所在⽬录(绝对,不受⼯作⽬录影响,建议采⽤此⽅法获取路径) var xmlPath = e(basePath, ""); // 添加 swagger xml 注释 这个xml⽂件开始是不存在的写上项⽬名.xml即可 eXmlComments(xmlPath); 然后再启动项⽬,可以看到我们的接⼝有注释了
发布者:admin,转转请注明出处:http://www.yc00.com/xiaochengxu/1689650126a273766.html
评论列表(0条)