asp.net web api 安装swagger
2024-10-16 19:01:37
使用nuget控制台,
输入 Install-Package Swashbuckle,回车,等待安装引用。nuget国内没有镜像,安装比较慢
安装成功后会多出一个引用
右键工程点--属性,左边导航栏选择--生成,勾选--XML文档文件,XML名字可以起符合命名规范的任意值,Ctrl+S。
引用Swagger工具后App_Start底下会多出一个SwaggerConfig.cs,点击打开
修改如下:
c.IncludeXmlComments(GetXmlCommentsPath());
private static string GetXmlCommentsPath()
{
return System.String.Format(@"{0}\bin\MDTController.XML", System.AppDomain.CurrentDomain.BaseDirectory);
}
直接访问:http://localhost/Controller/swagger/ui/index#/
如有错误:
webapi使用swagger出现“Cannot read property 'parameters' of null”
前端时间在webapi项目使用swagger来提供接口文档及测试工具,按网上方法(http://wmpratt.com/swagger-and-asp-net-web-api-part-1)配置好之后在浏览器控制台出现"Cannot read property ‘parameters‘ of null"错误。
后面发现问题出在//localhost:5645/swagger/docs/v1这个JSON资源上面,序列化出来的JSON,包含了为NULL的字段,导致swagger-ui-min-js出现异常。
进一步分析是因为我项目使用的newtonsoft.json这个库的配置导致,应该忽略为NULL的字段,如下:
//这里使用自定义日期格式
var jsonFormatter = new JsonMediaTypeFormatter();
var settings = jsonFormatter.SerializerSettings;
var timeConverter= new IsoDateTimeConverter { DateTimeFormat = "yyyy-MM-dd HH:mm:ss" };
settings.Converters.Add(timeConverter);
settings.NullValueHandling = NullValueHandling.Ignore;
config.Services.Replace(typeof(IContentNegotiator), new JsonContentNegotiator(jsonFormatter))
最新文章
- Power BI for Office 365(三)Power Pivot
- jxl读取Excel表格数据
- jQuery.cookie.js插件了解及使用方法
- 【jQuery】: 定时刷新页面
- android Camera 如何判断当前使用的摄像头是前置还是后置
- 寻找idea...
- Java笔记6之三目运算符
- 【jsp】读取WebRoot下的图像文件
- 实例PK(Vue服务端渲染 VS Vue浏览器端渲染)
- 《EntrePreneur》发刊词
- Webstorm 2017.3激活破解
- Angular记录(10)
- JAVA_Class.forName()用法详解
- 20155208 徐子涵 Exp3 免杀原理与实践
- php 二维数组按照某个键排序
- JavaScript实现HTML页面集成QQ空间分享功能
- 判断window.open的页面是否已经被关
- Linux学习笔记:Jenkins的使用
- poj1330-----------关于公共祖先的问题
- RabbitMQ None of the specified endpoints were reachable
热门文章
- html页面中iframe导致JavaScript失效
- CategoryPanelGroup动态生成节点
- c++builder 代码模板 code templates
- Flash Builder编译的swf为什么在bin-debug下运行正常,复制到其他文件夹就不正常
- C++ 实现的netstat -an 的功能<;转>;-目的为获取rtmp推流地址如果是域名的话查看1935的ip
- ABAP-动态ALV
- python语法学习之函数、类、模块
- hadoop 集群安装配置 【转】
- linux下面得小数计算
- CentOS7使用yum详细搭建zabbix3.2过程