net学习:C#在WEBAPI配置Swagger

本文介绍了如何在C#的WebAPI项目中配置Swagger,包括通过NuGet安装Swashbuckle,设置XML文件,配置SwaggerConfig以显示接口文档,以及解决接口显示问题。按照步骤操作后,开发者可以通过Swagger UI进行接口测试和文档查看。
摘要由CSDN通过智能技术生成

在前后端分开开发中,WEBAPI很多时候需要前后端联调,这其中就涉及到接口文档,代码的注释写全就可以用Swagger直接把接口文档在代码里生成出来。
一、建立WEBAPI项目:
在这里插入图片描述
二、nuget搜索Swashbuckle添加,如图:在这里插入图片描述项目中会出现SwaggerConfig配置文件,如图:
在这里插入图片描述
三、配置XML文件,如图:
在这里插入图片描述
接口中一般会用到Model层定义实体,所以也需要配置Model的XML,方法同上。
四、在SwaggerConfig里增加配置:
在这里插入图片描述
IncludeXmlComments可以配置多个,这样model层的注释也就显示

有时候接口会出现如图的情况,对接口没有影响,但是看

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值