为了防止博客被转载后，不保留本文的链接，特意在此加入本文的链接：https://www.cnblogs.com/yilezhu/p/9241261.html
为接口方法添加注释大家先点击下api，展开如下图所示，可以没有注释啊，怎么来添加注释呢？
按照下图所示用三个/添加文档注释，如下所示
/// <summary> /// 这是一个api方法的注释 /// </summary> /// <returns></returns> [HttpGet] public ActionResult<IEnumerable<string>> Get() { return new string[] { "value1", "value2" }; }然后运行项目，回到swaggerUI中去查看注释是否出现了呢
还是没有出现，别急，往下看！
启用XML 注释可使用以下方法启用 XML 注释：
右键单击“解决方案资源管理器”中的项目，然后选择“属性”
查看“生成”选项卡的“输出”部分下的“XML 文档文件”框
启用 XML 注释后会为未记录的公共类型和成员提供调试信息。如果出现很多警告信息 例如，以下消息指示违反警告代码 1591：
warning CS1591: Missing XML comment for publicly visible type or member 'TodoController.GetAll()'如果你有强迫症，想取消警告怎么办呢？可以按照下图所示进行取消
注意上面生成的xml文档文件的路径，
注意：
1.对于 Linux 或非 Windows 操作系统，文件名和路径区分大小写。 例如，“SwaggerDemo.xml”文件在 Windows 上有效，但在 CentOS 上无效。
2.获取应用程序路径，建议采用Path.GetDirectoryName(typeof(Program).Assembly.Location)这种方式
//注册Swagger生成器，定义一个和多个Swagger 文档 services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Version = "v1", Title = "yilezhu's API", Description = "A simple example ASP.NET Core Web API", TermsOfService = "None", Contact = new Contact { Name = "依乐祝", Email = string.Empty, Url = "http://www.cnblogs.com/yilezhu/" }, License = new License { Name = "许可证名字", Url = "http://www.cnblogs.com/yilezhu/" } }); // 为 Swagger JSON and UI设置xml文档注释路径 var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径） var xmlPath = Path.Combine(basePath, "SwaggerDemo.xml"); c.IncludeXmlComments(xmlPath); });重新生成并运行项目查看一下注释出现了没有
通过上面的操作可以总结出，Swagger UI 显示上述注释代码的 <summary> 元素的内部文本作为api大的注释！
当然你还可以将 remarks 元素添加到 Create 操作方法文档。 它可以补充 <summary> 元素中指定的信息，并提供更可靠的 Swagger UI。 <remarks> 元素内容可包含文本、JSON 或 XML。 代码如下：
/// <summary> /// 这是一个带参数的get请求 /// </summary> /// <remarks> /// 例子: /// Get api/Values/1 /// </remarks> /// <param>主键</param> /// <returns>测试字符串</returns> [HttpGet("{id}")] public ActionResult<string> Get(int id) { return $"你请求的 id 是 {id}"; }重新生成下项目，当好到SwaggerUI看到如下所示：
下面我们通过一个小例子通过SwaggerUI调试下接口吧
点击一个需要测试的API接口，然后点击Parameters左右边的“Try it out ” 按钮
在出现的参数文本框中输入参数，如下图所示的，输入参数2
点击执行按钮，会出现下面所示的格式化后的Response，如下图所示