项目swagger文档设置接口注释

1.项目文档根据注释生成文档文件

如果您使用了 Visual Studio 2019 及其更新版本，则无需启用 XML 注释文件的生成。只需在 WebAPI 项目中启用“生成输出”就足够了，XML 注释文件就会随项目一起构建和输出。要启用此功能，请打开项目属性，在左侧窗格中选择“生成”，然后在右侧窗格中将“生成输出”设置为“XML 文档文件”。

1.XML生成设置

项目 -> 右键 -> 属性

image-20230619172616900

勾选 ->生成包括API文档的文件

image-20230619172523827

项目下生成了对应的XML文件

image-20230619172733162

2.添加swagger XML配置

program.cs中添加代码如下：

image-20230619173244183

3.查看成果

启动项目，访问swagger地址：

https://localhost:7085/swagger/index.html

image-20230619173407124

1.接口注释

image-20230619173811958

2.参数模型注释

image-20230619173857405

3.swagger字段注释

image-20230619173730144