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