首页 技术 正文
技术 2022年11月21日
0 收藏 314 点赞 5,020 浏览 600 个字

1.创建webapi项目解决方案

WebAPI项目中使用SwaggerUI

2、引入Swagger组件

WebAPI项目中使用SwaggerUI

WebAPI项目中使用SwaggerUI

WebAPI项目中使用SwaggerUI

在项目引用中可以看到swagger的引用

WebAPI项目中使用SwaggerUI

3、webapi 项目右键属性->生成-> 勾选XML文档文件,然后将XML文件保存在项目bin目录下,后面swagger会读取XML文件用于UI展示

WebAPI项目中使用SwaggerUI

4、配置XML路径

swagger组件的引入自动为项目生成了配置代码,找到SwaggerConfig.cs 打开找到 c.IncludeXmlComments(GetXmlCommentsPath());

将其注释打开,表示需要加载XML文件,但此时GetXmlCommentsPath 方法是报错状态,需要我们去实现加载XML文件地址代码

WebAPI项目中使用SwaggerUI

接着在这个文件的下面,实现一下这个函数,XML文件名最好是与项目名一致

WebAPI项目中使用SwaggerUI

private static string GetXmlCommentsPath()
{
return string.Format("{0}/bin/SwaggerUiDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory);
}

5、解决运行报错

按照上面的步骤进行配置,应该是成功的才对,但是一运行就报错

WebAPI项目中使用SwaggerUI

网上查了一下资料,要打开swggernet文件,注释掉下面的两行代码。

WebAPI项目中使用SwaggerUI

再次运行,打开网页在URL后输入swagger即可访问api文档界面,URL形如:http://localhost:48914/swagger

WebAPI项目中使用SwaggerUI

相关推荐
python开发_常用的python模块及安装方法
adodb:我们领导推荐的数据库连接组件bsddb3:BerkeleyDB的连接组件Cheetah-1.0:我比较喜欢这个版本的cheeta…
日期:2022-11-24 点赞:878 阅读:9,105
Educational Codeforces Round 11 C. Hard Process 二分
C. Hard Process题目连接:http://www.codeforces.com/contest/660/problem/CDes…
日期:2022-11-24 点赞:807 阅读:5,582
下载Ubuntn 17.04 内核源代码
zengkefu@server1:/usr/src$ uname -aLinux server1 4.10.0-19-generic #21…
日期:2022-11-24 点赞:569 阅读:6,429
可用Active Desktop Calendar V7.86 注册码序列号
可用Active Desktop Calendar V7.86 注册码序列号Name: www.greendown.cn Code: &nb…
日期:2022-11-24 点赞:733 阅读:6,200
Android调用系统相机、自定义相机、处理大图片
Android调用系统相机和自定义相机实例本博文主要是介绍了android上使用相机进行拍照并显示的两种方式,并且由于涉及到要把拍到的照片显…
日期:2022-11-24 点赞:512 阅读:7,836
Struts的使用
一、Struts2的获取  Struts的官方网站为:http://struts.apache.org/  下载完Struts2的jar包,…
日期:2022-11-24 点赞:671 阅读:4,919