-
默认情况下我们api是没有注释的
-
在api方法上面添加xml注释
-
在Program.cs文件配置Swagger,添加以下代码
builder.Services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo {
Title = "My API", Version = "v1" });
var xmlFile = $"{
Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
c.IncludeXmlComments(xmlPath);
});
- 启动项目，查看效果
错误问题
如果说启动报下面的错误，则是因为是因为 Swagger 需要访问 XML 注释文件，但是你的项目中没有生成该文件。
为了生成该文件，请按照以下步骤操作：
- 在 Visual Studio 中右键单击项目并选择“属性”。
- 选择“生成”选项卡。 在“输出”下拉菜单中，将“生成包含API文档的文件”打勾。
- 保存更改并重新生成项目。
在重新生成项目后，应该会生成 XML 注释文件，这样 Swagger 就能访问它们了。