netcore webapi网站swagger接口界面支持注释

首先在services.AddSwaggerGen方法中增加如下代码：

 // 为 Swagger 设置xml文档注释路径
 var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
 // 添加控制器层注释，true表示显示控制器注释
 c.IncludeXmlComments(xmlPath, true);

其中此xml文件必须创建在根目录下。只需创建此文件，文件内容按默认即可

据此，如果只是在本地测试，就足够了。效果如下：

但是如果需要部署到服务器的IIS下。则还需要在项目生成选项卡页面勾选xml文档。注意看其自动生成的xml文档名是否和创建的xml文档名一致

 

另外

release和debug模式都要勾选xml文档选项。否则如果你少勾选一个。但是你生成的代码却是哪个模式下的。swagger界面会访问不到。提示500错误，而500错误的内容少的可怜。很难判断错误出在哪里