asp.net web api 安装swagger

亦凉 2021-04-27 15:47 468阅读 0赞

使用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))

发表评论取消回复

表情：

评论列表（有 0 条评论，468人围观）

还没有评论，来说两句吧...

相关阅读

相关 Swagger-API 文档生成

文章目录 * Swagger-API文档生成框架的基本使用 * * * * 1.swagger * * 1.1 官...

系统管理员/ 2024年04月19日 12:01/ 0 赞/ 105 阅读

相关 6.3 使用 Swagger 生成 Web API 文档

> 第6章构建 RESTful 服务 > > 6.1 [RESTful 简介][RESTful] > 6.2 [构建 RESTful 应用接口][RESTful 1

水深无声/ 2023年10月08日 17:54/ 0 赞/ 35 阅读

相关 ASP.NET Web API集成Swagger（1）-安装与简单配置

建立Web API项目 1. 新建项目–>ASP.NET MVC4项目–>WebAPI 2. [![d6de476945a5878c653e16cb8388ddb3.

淡淡的烟草味﹌/ 2022年12月22日 09:57/ 0 赞/ 135 阅读

相关 swagger api 之（二）

接上篇继续详解：[swagger api 之（一）][swagger api] > @ApiIgnore注解详情查看上篇文章中的HelloController.java,

柔光的暖阳◎/ 2022年06月09日 05:21/ 0 赞/ 180 阅读

相关 swagger api 之（一）

功能技术与IDE 代码参考github 代码片段启动应用程序访问url 返回结果

骑猪看日落/ 2022年06月09日 00:53/ 0 赞/ 221 阅读

相关 swagger注释API

swagger注释API ： [https://blog.csdn.net/chinassj/article/details/81875038][https_blog.c

雨点打透心脏的1/2处/ 2022年04月24日 02:24/ 0 赞/ 300 阅读

相关 .NET Web API 搭建Swagger

一、创建Net Web API项目 1.新建web应用程序 ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aH

雨点打透心脏的1/2处/ 2022年04月15日 02:56/ 0 赞/ 514 阅读

相关 [Swagger]swagger构建你的api文档

Swagger能成为最受欢迎的REST APIs文档生成工具之一，有以下几个原因： Swagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。

ゞ浴缸里的玫瑰/ 2022年04月12日 07:40/ 0 赞/ 403 阅读

相关 Swagger注解-@Api

使用场景在 Rest 接口类上边使用。概述标记类为 Swagger 资源类，运行时有效。属性 <table> <thead> <tr>

绝地灬酷狼/ 2022年02月14日 06:13/ 0 赞/ 393 阅读

相关 asp.net web api 安装swagger

使用nuget控制台，输入 Install-Package Swashbuckle，回车，等待安装引用。nuget国内没有镜像，安装比较慢安装成功后会多出一个引用...

亦凉/ 2021年04月27日 15:47/ 0 赞/ 469 阅读