给swagger添加文档注释详细步骤

Posted 2021-05-29 WeskyNet

提供swagger文档注释。

0、先给api加上标题注释和返回值注释：

 

 

 

然后，启动见证奇迹：

 

 

What the hell？没得注释？查看当前自动生成的swagger代码如下：

 

 

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

 

 

 

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

 

 

 

然后，把一些代码也做下更改：

 

 

 代码如下：

services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo 
                { 
                    Title = "这是文档标题",
                    Version = "文档版本编号",
                    Description = "文档描述"
                });
                var file = Path.Combine(AppContext.BaseDirectory, "Wsk.Core.xml");  // xml文档绝对路径
                var path = Path.Combine(AppContext.BaseDirectory, file); // xml文档绝对路径
                c.IncludeXmlComments(path, true); // true : 显示控制器层注释
                c.OrderActionsBy(o => o.RelativePath); // 对action的名称进行排序，如果有多个，就可以看见效果了。

            });

 

现在再次见证一下奇迹：

 

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

 

如果您觉得有帮助，欢迎不限金额打赏呀~~