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

认识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 some services are not able to be constructed (error while validating the service descriptor 'servicetype:
2 swashbuckle.aspnetcore.swagger.iswaggerprovider lifetime: transient implementationtype:
3 swashbuckle.aspnetcore.swaggergen.swaggergenerator': failed to compare two elements in the array.)
4 (error while validating the service descriptor 'servicetype: swashbuckle.aspnetcore.swaggergen.ischemaregistryfactory lifetime:
5 transient implementationtype: swashbuckle.aspnetcore.swaggergen.schemaregistryfactory': failed to compare two elements in the array.)

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

在.netcore3.0中 配置swagger 也发生变化，
由以前的

1 services.addswaggergen(c =>
2 {
3 　　c.swaggerdoc("v1", new info { title = "my api", version = "v1" });
4 });

变更为

1 services.addswaggergen(c =>
2  {
3        c.swaggerdoc("v1", new openapiinfo { title = "my api", version = "v1" });
4  });

其中最大的变化就是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 public void configureservices(iservicecollection services)
 2 {
 3 
 4 services.addcontrollers();
 5 
 6 services.addswaggergen(c =>
 7 {
 8 c.swaggerdoc("v1", new openapiinfo { title = "my api", version = "v1" });
 9 });
10 
11 }

配置swagger ui

 1 public void configure(iapplicationbuilder app, iwebhostenvironment env)
 2 {
 3 if (env.isdevelopment())
 4 {
 5 app.usedeveloperexceptionpage();
 6 }
 7 app.usehttpsredirection();
 8 app.userouting();
 9 app.useauthorization();
10 //启用swagger
11 app.useswagger();
12 //配置swagger ui
13 app.useswaggerui(c =>
14 {
15 c.swaggerendpoint("/swagger/v1/swagger.json", "my api"); //注意中间段v1要和上面swaggerdoc定义的名字保持一致
16 });
17 app.useendpoints(endpoints =>
18 {
19 endpoints.mapcontrollers();
20 });
21 }

启动项目

ctrl+f5启动项目，并导航到 http://localhost:port/swagger 通过swagger ui游览api文档

swagger的高级用法（自定义扩展）

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

 1 services.addswaggergen(c =>
 2  {
 3            c.swaggerdoc("v1", new openapiinfo
 4             {
 5                     title = "my api",
 6                     version = "v1",
 7                     description = "api文档描述",
 8                     contact = new openapicontact
 9                     {
10                         email = "[e-mail]",
11                         name = "开源netcore",
12                         url = new uri("http://www.netcore.pub/")
13                     },
14                     license = new openapilicense
15                     {
16                         name = "许可证名称",
17                         url = new uri("http://www.netcore.pub/")
18                     }
19             });
20  });

swagger ui 显示版本的信息如下图所示

为api接口方法添加注释

大家先点开api，展开如下图所示，可是没有注释呀，怎么添加注释呢？

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

 1 /// <summary>
 2 /// 这是一个api注释
 3 /// </summary>
 4 /// <returns></returns>
 5 [httpget]
 6 public ienumerable<weatherforecast> get()
 7  {
 8             var rng = new random();
 9             return enumerable.range(1, 5).select(index => new weatherforecast
10             {
11                 date = datetime.now.adddays(index),
12                 temperaturec = rng.next(-20, 55),
13                 summary = summaries[rng.next(summaries.length)]
14             })
15             .toarray();
16 }

然后运行项目，回到swagger ui中去查看注释是否出现了呢

还是没出现？一脸懵逼？？？ 别急往下看！

启用xml注释

可使用以下方法启用 xml 注释：

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

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

1 warning cs1591: missing xml comment for publicly visible type or member 'todocontroller.getall()'

如果你有强迫症，想取消警告怎么办呢？可以按照下图所示进行取消

注意上面生成的xml文档文件的路径，

注意：

​ 1.对于 linux 或非 windows 操作系统，文件名和路径区分大小写。 例如，“kylin.wiki.xml”文件在 windows 上有效，但在 centos 上无效。

​ 2.获取应用程序路径，建议采用path.getdirectoryname(typeof(program).assembly.location)这种方式或者·appcontext.basedirectory这样来获取

 1 services.addswaggergen(c =>
 2             {
 3                 c.swaggerdoc("v1", new openapiinfo
 4                 {
 5                     title = "my api",
 6                     version = "v1",
 7                     description = "api文档描述",
 8                     contact = new openapicontact
 9                     {
10                         email = "[e-mail]",
11                         name = "开源netcore",
12                         url = new uri("http://www.netcore.pub/")
13                     },
14                     license = new openapilicense
15                     {
16                         name = "许可证名称",
17                         url = new uri("http://www.netcore.pub/")
18                     }
19                 });
20                 // 为 swagger json and ui设置xml文档注释路径
21                 var basepath = path.getdirectoryname(typeof(program).assembly.location);//获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径）
22                 var xmlpath = path.combine(basepath, "kylin.wiki.xml");
23                 c.includexmlcomments(xmlpath);
24  });

重新生成并运行项目查看一下注释出现了没有

通过上面的操作可以总结出，swagger ui 显示上述注释代码的元素的内部文本作为api大的注释！

当然你还可以将 remarks 元素添加到 get 操作方法文档。 它可以补充元素中指定的信息，并提供更可靠的 swagger ui。 元素内容可包含文本、json 或 xml。 代码如下：

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

重新生成下项目，当好到swaggerui看到如下所示：

描述响应类型

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

我们需要在我们的方法上添加：

[producesresponsetype(201)]

[producesresponsetype(400)]

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

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

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

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

使用swaggerui测试api接口

下面我们通过一个小例子通过swaggerui调试下接口吧

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

好了，今天的在asp.net core webapi 3.0 中使用swagger生成api说明文档教程就到这里了。希望能够对大家学习在asp.net core中使用swagger生成api文档有所帮助！

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

 

除非注明，文章均由开源 netcore 整理发布，欢迎转载。

转载请注明本文地址：

站长会将优质文章在各大平台同步更新、推送，欢迎大家访问、订阅：

博客园： https://www.cnblogs.com/zenderblogs/