.net core webapi 为swagger添加文档注释

供swagger文档注释。

先给api加上标题注释和返回值注释:

.net core webapi 为swagger添加文档注释_第1张图片

 

.net core webapi 为swagger添加文档注释_第2张图片

 

 

然后,启动见证奇迹:

.net core webapi 为swagger添加文档注释_第3张图片

 

What the hell?没得注释?当前自动生成的swagger代码如下:

.net core webapi 为swagger添加文档注释_第4张图片

 

首先,我们需要对需要注释的地方,添加xml文档。右键项目属性,生成下面,对XML文档进行打钩,会自动生成一个xml文档。

.net core webapi 为swagger添加文档注释_第5张图片

 

然后右键项目,生成以后,项目下面多出一个xml文件,右键xml文件到属性,选择始终复制。如果没有点始终复制,将来发布到其他地方时候,有可能不会带出xml文档,轻则swagger不会显示注释,重则页面打开会报错文件丢失等。

.net core webapi 为swagger添加文档注释_第6张图片

 

 

然后,把一些代码也做下更改:

.net core webapi 为swagger添加文档注释_第7张图片

 

现在再次见证一下奇迹:

.net core webapi 为swagger添加文档注释_第8张图片

 

哦吼,注释全出来了,以及代码里面写的标题、描述版本号等也在对应的区域显示出对应效果。到此结束。

你可能感兴趣的:(.net,core,xml)