.net 只需三步让Swagger显示注释

.net 只需三步让Swagger显示注释

先看效果

第一步：导包(我使用的是.net5.0的框架，所以导入5.x的包，如果你使用.net6.0的框架，注意改版本号)

Install-Package Swashbuckle.AspNetCore.Annotations -v 5.6.3

第二步：配置Swagger服务，调用EnableAnnotations()方法以启用注释

services.AddSwaggerGen(c =>
{
	c.EnableAnnotations();
});

第三步：之后在需要显示注释的Action上增加特性

[SwaggerOperation(Summary = "注释内容")]

这样你的Action看起来像这样

[HttpGet]
[SwaggerOperation(Summary = "注释内容")]
public string Hello()
{
    return "hello";
}

启动项目即可在Swagger看到注释