net学习:C#在WEBAPI配置Swagger

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

有时候接口会出现如图的情况,对接口没有影响,但是看着不舒服,如图:
在这里插入图片描述
这样的情况只需要,在SwaggerConfig配置中添加c.DisableValidator();,如图:
在这里插入图片描述
到此,swagger配置已经完成,运行项目访问http:##/swagger/ui/index,就可以看到效果了,如图:在这里插入图片描述
开始你的swagger配置吧

猜你喜欢

转载自blog.csdn.net/weixin_41812784/article/details/98037685