.Net Core2.1 WebAPI新增Swagger插件详解-6ren

.Net Core2.1 WebAPI新增Swagger插件详解

转载作者：qq735679552 更新时间：2022-09-29 22:32:09

CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章.Net Core2.1 WebAPI新增Swagger插件详解由作者收集整理，如果你对这篇文章有兴趣，记得点赞哟.

说明。

Swagger是一个WebAPI在线注解、调试插件，过去我们主要通过手工撰写WebAPI接口的交互文档供前端开发人员或外部开发者，。

官网地址：https://swagger.io/.

但是在实际工作中，往往咋们的文档工作通常落后于实际的环境，导致文档和实际接口不一致，前后端开发人员苦不堪言.

Swagger的出现解放了接口文档撰写的麻烦也提高了前后端开发者的工作效率，所谓“工欲善其事,必先利其器 ”。现在让咋们。

了解下在.NET Core 2.1下如何实现Swagger.

1、Nuget安装依赖包。

首先Nuget安装Swashbuckle.AspNetCore 。

打开Nuget控制台(程序包管理控制台)，键入下列命令。

 
    ? 
   
         Install-Package Swashbuckle.AspNetCore

2、添加Swagger中间件。

 
         public 
         IServiceProvider ConfigureServices(IServiceCollection services) 
        
         { 
        
         services.Configure<CookiePolicyOptions>(options => 
        
         { 
        
         // This lambda determines whether user consent for non-essential cookies is needed for a given request. 
        
         options.CheckConsentNeeded = context =>  
         true 
         ; 
        
         options.MinimumSameSitePolicy = SameSiteMode.None; 
        
         }); 
        
         services.AddMvc().AddJsonOptions(options => 
        
         { 
        
         //忽略循环引用 
        
         options.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore; 
        
         //不使用驼峰样式的key 
        
         options.SerializerSettings.ContractResolver =  
         new 
         DefaultContractResolver(); 
        
         }) 
        
         .SetCompatibilityVersion(CompatibilityVersion.Version_2_1); 
        
         // Register the Swagger generator, defining 1 or more Swagger documents 
        
         services.AddSwaggerGen(c => 
        
         { 
        
         c.SwaggerDoc( 
         "v1" 
         ,  
         new 
         Info { csharp" id="highlighter_996223"> 
           
           ? 
          
                public 
                void 
                Configure(IApplicationBuilder app, IHostingEnvironment env) 
               
                { 
               
                if 
                (env.IsDevelopment()) 
               
                { 
               
                app.UseDeveloperExceptionPage(); 
               
                } 
               
                // Enable middleware to serve generated Swagger as a JSON endpoint. 
               
                app.UseSwagger(); 
               
                // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.),  
               
                // specifying the Swagger JSON endpoint. 
               
                app.UseSwaggerUI(c => 
               
                { 
               
                c.SwaggerEndpoint( 
                "/swagger/v1/swagger.json" 
                ,  
                "My API V1" 
                ); 
               
                }); 
               
                app.UseVisitLogger(); 
               
                app.UseMvc(); 
               
                }

3、配置WebAPI项目属性。

1、双击Properties下的launchSettings.json，将launchUrl更新为swagger 。

F5结果如下:

4、新增注解。

如上图，虽然WebAPI已经出来了，但是呢，并没有发现我们在Action上写的注释? 老司机应该知道在Framework版本里我们需要。

将WebAPI启动项属性里更改“项目生产“一栏中新增XML文档，.NetCore也是如此。如下图

保存后，按F5发现并木有生产注解，Why??? 那是因为我们必须明确告诉Swagger应该从哪个路径读取WebAPI注解XML文件，更新Startup下的ConfigureServices.

参考下面代码

 
          
           
            
            ? 
            
            
             
              
               
               
                 1 
                
               
                 2 
                
               
                 3 
                
               
                 4 
                
               
                 5 
                
               
                 6 
                
               
                 7 
                
               
                 8 
                
               
                 9 
                
               
                 10 
                
               
                 11 
                
               
                 12 
                
               
                 13 
                
               
                 14 
               
  
               
                
                 
                 // Register the Swagger generator, defining 1 or more Swagger documents 
                 
                 
                   
                 services.AddSwaggerGen(options => 
                 
                 
                   
                 { 
                 
                 
                    
                 options.SwaggerDoc( 
                 "v1" 
                 ,  
                 new 
                 Info { src="/uploads/allimg/200529/15295V396-3.png" />
 是不是很爽~~ 。
还有，Swagger是支持授权登录的哦，这个待研究.
总结 。
以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对我的支持.
原文链接：https://www.cnblogs.com/hunanzp/archive/2018/07/08/9279906.html 。
  
                 
                 
                  
                 
  
               
 
                 
                  
                   
                  .NET 
                  core 
                  Swagger 
                  WebAPI 
                  
                  
                   
                  
                 
                 
                  
                  延伸 · 阅读 
                  
                  
                  2020-05-29.net core xss攻击防御的方法 
                  2020-05-29.Net使用RabbitMQ即时发消息Demo 
                  2020-05-29.NET core高性能对象转换示例代码 
                  2020-05-29jenkins部署.net平台自动化构建的方法步骤 
                  2020-05-29.NET Core控制台应用程序如何使用异步（Async）Ma 
                  2020-05-29.NET/ASP.NET Routing路由(深入解析路由系统架构原理 
                  
                 
                 
                 
                 
                  
                   
                  
                 
                 
                 
                   精彩推荐 
                  
                 
                 
                  
                   
                    
                   
                  ASP.NET教程 
                    
                    asp.net Xml绑定到数据控件的具体实现 
                    这篇文章主要介绍了asp.net Xml绑定到数据控件的两种简单方法 ,需要的朋友可以参考下... 。 
                     
                     ASP.NET教程网 
                     406 
                     2019-12-04 
                     
                   
  
                  ASP.NET教程 
                    
                    在Web用户控件中引用样式表中样式的方法 
                    在Web用户控件中引用样式表中样式有很多方法，在本文将为大家介绍下具体实现... 。 
                     
                     ASP.NET教程网 
                     356 
                     2019-11-22 
                     
                   
  
                  ASP.NET教程 
                    
                    未在本地计算机上注册“microsoft.ACE.oledb.12.0”提供程序报错的解 
                    这篇文章主要给大家介绍了关于未在本地计算机上注册“microsoft.ACE.oledb.12.0”提供程序报错的完美解决办法，需要的朋友可以参考下... 。 
                     
                     willingtolove 
                     294 
                     2019-06-19 
                     
                   
  
                  ASP.NET教程 
                    
                    asp.net Silverlight中的模式窗体 
                    现在Web开发技术中流行着模式窗体，这种不用跳转页面又能够满足与用户进行数据交互的手段确实不错，那我今天也谈谈Silverlight中的模式窗体吧。... 。 
                     
                     脚本之家 
                     210 
                     2019-06-20 
                     
                   
  
                  ASP.NET教程 
                    
                    ASP.NET向Javascript传递变量两种实现方法 
                    ASP.NET向Javascript传递变量两种实现方法，需要的朋友可以参考下... 。 
                     
                     asp.net教程网 
                     159 
                     2019-10-12 
                     
                   
  
                  ASP.NET教程 
                    
                    div弹出层的ajax登录(Jquery版+c#) 
                    这次主要的分享就是div+css+jquery，你可以改版成你要的登录，随意改版！后台代码由于时间限制，没有完成，里面有些乱，重点分享界面，还望理解... 。 
                     
                     asp.net技术网 
                     194 
                     2019-10-08 
                     
                   
  
                  ASP.NET教程 
                    
                    在ASP.NET 2.0中操作数据之二：创建一个业务逻辑层 
                    本文主要介绍 ASP.NET 2.0 如何创建业务逻辑层，业务逻辑层主要定义一些业务规则，调用已经定义好的数据库访问层代码，将读取、插入、修改以及删除等方... 。 
                     
                     heker2007 
                     436 
                     2020-01-06 
                     
                   
  
                  ASP.NET教程 
                    
                    asp.net实现生成静态页并添加链接的方法 
                    这篇文章主要介绍了asp.net实现生成静态页并添加链接的方法,非常实用的功能,需要的朋友可以参考下... 。 
                     
                     shichen2014 
                     308 
                     2019-12-06 
                     
                   
  
                  
                 
                 
                  
                   
                  
                  
                   
                   最近更新 
                   
                   
                    
                    .net core xss攻击防御的方法 
                    .Net Core2.1 WebAPI新增Swagger插件详解 
                    .Net使用RabbitMQ即时发消息Demo 
                    .NET core高性能对象转换示例代码 
                    ASP.NET MVC如何使用Unity实现Ioc详解 
                    
                   
                  
                  
                   
                   编辑推荐 
                   
                   
                    
                     
                      
                       
                       
                       2020最新好用的web服务器软件推荐 
                       
                      
                    2 
                      
                      服务器操作系统有哪些? 
                      2020-04-06 
                      
                    3 
                      
                      web服务器配置（图文详解） 
                      2020-04-06 
                      
                    4 
                      
                      企业如何选择阿里云服务器配置? 
                      2019-10-18 
                      
                    5 
                      
                      五大免费主机管理系统优缺点对比及推荐 
                      2019-06-14 
                      
                    6 
                      
                      2019最新三款Windows下连接Linux的ssh软件下载推荐 
                      2019-05-28 
                      
                    7 
                      
                      服务器常用管理软件盘点 
                      2019-05-27 
                      
                    8 
                      
                      Nginx服务器究竟是怎么执行PHP项目 
                      2019-05-24 
                      
                    9 
                      
                      运维必须知道的关于云服务器的十个问题 
                      2019-05-24 
                      
                    10 
                      
                      什么叫cdn服务器？怎么部署？ 
                      2019-05-24 
                      
                    
                   
                  
                  
                   
                   阅读排行 
                   
                   
                    
                    1 JS实现完美include加载功能代码 
                    2 asp.net 字符串、二进制、编码数组转换函数 
                    3 asp.net AutoCompleteExtender的一个简单例子代码 
                    4 ASP.NET登录注册页面实现 
                    5 asp.net 扩展GridView 增加单选按钮列的代码 
                    6 ASP.NET 图片防盗链的实现原理分析 
                    7 CheckBox为CheckBoxList实现全选或全取消选择(js代 
                    8 网页(aspx)与用户控件(ascx)交互逻辑处理实现 
                    9 asp.net 汉字转换拼音及首字母实现代码 
                    10 asp.net 生成缩略图代码 
                    
                   
                  
                  
                   
                   热门标签 
                   
                   
                   
                     参数验证 　 循环顺序播放 　 编译不通过 　 connectionStrings 　 Linkbutton 　 App.config 　 逆变 　 System.IO 　 XSLT 　 XmlSerializer 　 表头 　 MD.DLL 　 wsdl.exe 　 RowUpdating 　 层次结构数据 　 BitmapImage 　 图片删除 　 Delegate 　 内部原理 　 自动跳转页面 　 UdpClient 　 子对象 　 STAThread 　 循环处理数据 　 Lumisoft.NET 　 CommandField 　 ASPX文件怎么打开 　 aspx文件 　 aspx是什么文件 　 aspx是什么格式 　 
                    
                   
                  
                  
                   
                  
                 
                 
                 
                  
                  © 2019-2020 我 版权所有 www.zzvips.com  
                  关于我们联系我们版权申明网站地图

最后此篇关于.Net Core2.1 WebAPI新增Swagger插件详解的文章就讲到这里了,如果你想了解更多关于.Net Core2.1 WebAPI新增Swagger插件详解的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！。

文章推荐： .Net Core Cors中间件的深入讲解

文章推荐： .net core xss攻击防御的方法

文章推荐： .Net使用RabbitMQ即时发消息Demo

文章推荐： .NET core高性能对象转换示例代码

jstat 详解
全称“Java Virtual Machine statistics monitoring tool”（statistics 统计；monitoring 监控；tool 工具）用于监控虚拟机的各种运
MongoDB索引操作和执行计划Explain()详解
主要是讲下Mongodb的索引的查看、创建、删除、类型说明，还有就是Explain执行计划的解释说明。可以转载，但请注明出处。
Linux下几种并发服务器的实现模式(详解)
1>单线程或者单进程相当于短链接，当accept之后，就开始数据的接收和数据的发送，不接受新的连接，即一个server，一个client 不存在并发。 2>循环服务器和并发服务器
详解 Linux中的关机和重启命令
详解 linux中的关机和重启命令一 shutdown命令 shutdown [选项] 时间选项： ?
用Newtonsoft将json串转为对象的方法(详解)
首先，将json串转为一个JObject对象： ? 1
Python画图常用命令大全(详解)
matplotlib官网 matplotlib库默认英文字体添加黑体（‘SimHei'）为绘图字体代码： plt.rcParams['font.sans-serif']=['SimHei'
Java中的关键字synchronized 详解
在并发编程中，synchronized关键字是常出现的角色。之前我们都称呼synchronized关键字为重量锁，但是在jdk1.6中对synchronized进行了优化，引入了偏向锁、轻量锁。本篇
详解.NET数据库连接池
一般我们的项目中会使用1到2个数据库连接配置，同程艺龙的数据库连接配置被收拢到统一的配置中心，由DBA统一配置和维护，业务方通过某个字符串配置拿到的是Connection对象。
linux下gettimeofday函数windows替换方法(详解)
实例如下： ? 1
详解.Net缓存之MemoryCahe
1. MemoryCahe NetCore中的缓存和System.Runtime.Caching很相似，但是在功能上做了增强，缓存的key支持object类型；提供了泛型支持；可以读缓存和单个缓存
Javascript基础教程之argument 详解
argument是javascript中函数的一个特殊参数，例如下文，利用argument访问函数参数，判断函数是否执行复制代码代码如下: <script
linux中了minerd之后的完全清理过程(详解)
一不小心装了一个Redis服务，开了一个全网的默认端口，一开始以为这台服务器没有公网ip，结果发现之后悔之莫及啊某天发现cpu load高的出奇，发现一个minerd进程占了大量cpu，googl
基于php编程规范(详解)
今天写这个是为了提醒自己编程过程不仅要有逻辑思想还有要规范代码这样可读性 1、PHP 编程规范与编码习惯最主要的有以下几点： 1 文件说明 2 funct
使用yum查看工具lspci所在包并安装的方法(详解)
摘要：虚拟机安装时一般都采用最小化安装，默认没有lspci工具。一台测试虚拟网卡性能的虚拟机，需要lspci工具来查看网卡的类型。本文描述了在一个虚拟机中安装lspci工具的具体步骤。由于要测试
Linux下高并发socket最大连接数所受的各种限制(详解)
1、修改用户进程可打开文件数限制在Linux平台上，无论编写客户端程序还是服务端程序，在进行高并发TCP连接处理时，最高的并发数量都要受到系统对用户单一进程同时可打开文件数量的限制(这是因为系统
一篇文章带你入门java运算符(详解)
目录算术运算符基本四则运算符增量赋值运算符自增/自减运算符关系运算符逻
PHP面向对象之事务脚本模式(详解)
如下所示： ? 1
详解 MapperScannerConfigurer之sqlSessionFactory注入方式
MapperScannerConfigurer之sqlSessionFactory注入方式讲解首先，Mybatis中的有一段配置非常方便，省去我们去写DaoImpl（Dao层实现类）的时间，这个
详解：Linux网络虚拟化技术
Linux的网络虚拟化是LXC项目中的一个子项目，LXC包括文件系统虚拟化，进程空间虚拟化，用户虚拟化，网络虚拟化，等等，这里使用LXC的网络虚拟化来模拟多个网络环境。本文从基本的网络设备讲
highchart数据源纵轴json内的值必须是int(详解)
? 1

qq735679552

个人简介

我是一名优秀的程序员,十分优秀！

作者热门文章

滴滴打车优惠券免费领取

全站热门文章

首页

博学

6Ren·AI

商城

.Net Core2.1 WebAPI新增Swagger插件详解

延伸 · 阅读

asp.net Xml绑定到数据控件的具体实现

在Web用户控件中引用样式表中样式的方法

未在本地计算机上注册“microsoft.ACE.oledb.12.0”提供程序报错的解

asp.net Silverlight中的模式窗体

ASP.NET向Javascript传递变量两种实现方法

div弹出层的ajax登录(Jquery版+c#)

在ASP.NET 2.0中操作数据之二：创建一个业务逻辑层

asp.net实现生成静态页并添加链接的方法

服务器操作系统有哪些?

web服务器配置（图文详解）

企业如何选择阿里云服务器配置?

五大免费主机管理系统优缺点对比及推荐

2019最新三款Windows下连接Linux的ssh软件下载推荐

服务器常用管理软件盘点

Nginx服务器究竟是怎么执行PHP项目

运维必须知道的关于云服务器的十个问题

什么叫cdn服务器？怎么部署？