.net 配置swagger


第一步:

在nuget.org中查找Swashbuckle并下载

 

 

 

 

在nuget.org中查找Swagger.net.UI,并下载

 

 

       

第二步:

下载完之后,App_Start多了三个文件

Swagger.Auth.cs

SwaggerConfig.cs

SwaggerNet.cs

将SwaggerNet.cs删除,没用的cs文件

 

 

 

 

 

第三步:

配置:SwaggerConfig.cs

c.IncludeXmlComments(string.Format("{0}/bin/SwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory));

 

放在 GlobalConfiguration.Configuration

                .EnableSwagger(c =>

                    {}

当中

 

 

 

 

第四步:

点击项目下的小扳手

找到生成中的输出,勾选XML文档文件,将文件名改为与上一步当中的XML文件名一致

 

 

将禁止显示警告设为1591,不然会警告没有设置XML文档注释,保存即可

 

 

成果显示:默认的路径就是http://localhost:56708/swagger(api路径/swagger)

 

 

最后一步

只需加上注释即可

注意:注释必须使用文档注释,///

 

 

 

可以直接测试数据,s输入ID,点击Try it out

 

 

 

最终效果

 

 


免责声明!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系本站邮箱yoyou2525@163.com删除。



 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM