开源NetCore
当前位置: NetCore > .NetCore 3.0 中使用Swagger生成Api说明文档及升级报错原因

.NetCore 3.0 中使用Swagger生成Api说明文档及升级报错原因

2019-12-11 分类:NetCore 作者:zhanghao 阅读(1449)

认识Swagger

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
作用:

  1. 接口的文档在线自动生成。
  2. 功能测试。

为什么使用Swagger作为REST APIs文档生成工具

  1. Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。
  2. Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
  3. Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
  4. Swagger 有一个强大的社区,里面有许多强悍的贡献者。、

安装Nuget包

搜索Swashbuckle.AspNetCore

因为是.NetCore3.0 ,所以一定要勾选包括预览发行版,安装最新预发行版 5.0.0-rc4,千万不要安装最新稳定版。稳定版会报错。
稳定版报错信息:

1
2
3
4
5
Some services are not able to be constructed (Error while validating the service descriptor 'ServiceType:
Swashbuckle.AspNetCore.Swagger.ISwaggerProvider Lifetime: Transient ImplementationType:
Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator'
: Failed to compare two elements in the array.)
(Error while validating the service descriptor 'ServiceType: Swashbuckle.AspNetCore.SwaggerGen.ISchemaRegistryFactory Lifetime:
Transient ImplementationType: Swashbuckle.AspNetCore.SwaggerGen.SchemaRegistryFactory'
: Failed to compare two elements in the array.)

解决办法就是3.0版本中要安装现在预览发行版5.0.0-rc4

在.NetCore3.0中 配置Swagger 也发生变化,
由以前的
//注册Swagger生成器,定义一个和多个Swagger 文档

1
2
3
4
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
});

变更为

1
2
3
4
services.AddSwaggerGen(c =>
 {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
 });

其中最大的变化就是Info这里,在以前2.0版本中是由Swagger来管理的。在3.0版本中统一变更为 OpenApi管理,OpenApi 在官方文档中介绍为是用于管理项目内 OpenAPI 引用的 .NET Core 全局工具。参考地址:(https://docs.microsoft.com/zh-cn/aspnet/core/web-api/microsoft.dotnet-openapi?view=aspnetcore-3.1 "使用 OpenAPI 工具开发 ASP.NET Core 应用")

所以在添加完Swagger 包后,还要在项目中添加Microsoft.OpenApi包

注册Swagger

1
2
3
4
5
6
7
8
9
10
11
public void ConfigureServices(IServiceCollection services)
{

services.AddControllers();

services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});

}

启动Swagger

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseHttpsRedirection();
app.UseRouting();
app.UseAuthorization();
//启用Swagger
app.UseSwagger();
//配置Swagger UI
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API"); //注意中间段v1要和上面SwaggerDoc定义的名字保持一致
});
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});
}

启动项目

CTRL+F5启动项目,并导航到 http://localhost:/swagger 通过Swagger UI游览API文档

Swagger的高级用法(自定义扩展)

AddSwaggerGen 方法的进行如下的配置操作会添加诸如作者、许可证和说明信息等:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
services.AddSwaggerGen(c =>
 {
                c.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "My API",
                    Version = "v1",
                    Description = "API文档描述",
                    Contact = new OpenApiContact
                    {
                        Email = "8596007@qq.com",
                        Name = "开源NetCore",
                        Url = new Uri("http://www.netcore.pub/")
                    },
                    License = new OpenApiLicense
                    {
                        Name = "许可证名称",
                        Url = new Uri("http://www.netcore.pub/")
                    }
                });
 });

Swagger UI 显示版本的信息如下图所示

为API接口方法添加注释

大家先点开API,展开如下图所示,可是没有注释呀,怎么添加注释呢?

按照下列代码所示用三个/添加文档注释,如下所示

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/// <summary>
/// 这是一个API注释
/// </summary>
/// <returns></returns>
[HttpGet]
public IEnumerable<WeatherForecast> Get()
 {
            var rng = new Random();
            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            })
            .ToArray();
}

然后运行项目,回到Swagger UI中去查看注释是否出现了呢

还是没出现?一脸懵逼??? 别急往下看!

启用XML注释

启用XML 注释
可使用以下方法启用 XML 注释:

右键单击“解决方案资源管理器”中的项目,然后选择“属性”
查看“生成”选项卡的“输出”部分下的“XML 文档文件”框

启用 XML 注释后会为未记录的公共类型和成员提供调试信息。如果出现很多警告信息 例如,以下消息指示违反警告代码 1591:

1
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)这种方式或者·AppContext.BaseDirectory这样来获取

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "My API",
                    Version = "v1",
                    Description = "API文档描述",
                    Contact = new OpenApiContact
                    {
                        Email = "8596007@qq.com",
                        Name = "开源NetCore",
                        Url = new Uri("http://www.netcore.pub/")
                    },
                    License = new OpenApiLicense
                    {
                        Name = "许可证名称",
                        Url = new Uri("http://www.netcore.pub/")
                    }
                });
                // 为 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 显示上述注释代码的

元素的内部文本作为api大的注释!

当然你还可以将 remarks 元素添加到 Get 操作方法文档。 它可以补充

元素中指定的信息,并提供更可靠的 Swagger UI。 元素内容可包含文本、JSON 或 XML。 代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
/// <summary>
/// 这是一个带参数的get请求
/// </summary>
/// <remarks>
/// 例子:
/// Get api/Values/1
/// </remarks>
/// <param name="id">主键</param>
/// <returns>测试字符串</returns>    
public ActionResult<string> Get(int id)
{
      return $"你请求的 id 是 {id}";
}

重新生成下项目,当好到SwaggerUI看到如下所示:

描述响应类型

接口使用者最关心的就是接口的返回内容和响应类型啦。下面展示一下201和400状态码的一个简单例子:

我们需要在我们的方法上添加:[ProducesResponseType(201)][ProducesResponseType(400)]

然后添加相应的状态说明:返回value字符串如果id为空

最终代码应该是这个样子:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 /// <summary>
 /// 这是一个带参数的get请求
 /// </summary>
 /// <remarks>
 /// 例子:
 /// Get api/Values/1
 /// </remarks>
 /// <param name="id">主键</param>
 /// <returns>测试字符串</returns>
 /// <response code="201">返回value字符串</response>
/// <response code="400">如果id为空</response>  
 // GET api/values/2
[HttpGet("{id}")]
[ProducesResponseType(201)]
[ProducesResponseType(400)]
public ActionResult<string> Get(int id)
{
     return $"你请求的 id 是 {id}";
}

效果如下所示
状态相应效果

使用SwaggerUI测试api接口
下面我们通过一个小例子通过SwaggerUI调试下接口吧

点击一个需要测试的API接口,然后点击Parameters左右边的“Try it out ” 按钮
在出现的参数文本框中输入参数,如下图所示的,输入参数2
点击执行按钮,会出现下面所示的格式化后的Response,如下图所示

好了,今天的在ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了的教程就到这里了。希望能够对大家学习在ASP.NET Core中使用Swagger生成api文档有所帮助!

「开源NetCore,如果觉得我的文章对您有用,请帮助本站成长」

赞(0) 打赏

谢谢支持!

支付宝
微信
0

谢谢支持!

支付宝
微信
标签:

上一篇:

下一篇:

你可能感兴趣

共有 1 条评论 - .NetCore 3.0 中使用Swagger生成Api说明文档及升级报错原因

博客简介

开源NetCore博客: netcore.pub,一个关注NetCore开发技术、Web前端开发技术、关注用户体验、坚持更多原创实战教程的个人网站。

站点统计

  • 文章总数: 15 篇
  • 草稿数目: 2 篇
  • 分类数目: 15 个
  • 独立页面: 3 个
  • 评论总数: 1 条
  • 链接总数: 2 个
  • 标签总数: 13 个
  • 建站时间: 295 天
  • 注册用户: 1 人
  • 最近更新: 2019年12月27日