认识SwaggerSwagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
为什么使用Swagger作为REST APIs文档生成工具
安装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包 注册Swagger1 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 UI1 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 = "8596007@qq.com", 11 Name = "开源NetCore", 12 Url = new Uri("http://www./") 13 }, 14 License = new OpenApiLicense 15 { 16 Name = "许可证名称", 17 Url = new Uri("http://www./") 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 注释: 右键单击“解决方案资源管理器”中的项目,然后选择“属性” 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 = "8596007@qq.com", 11 Name = "开源NetCore", 12 Url = new Uri("http://www./") 13 }, 14 License = new OpenApiLicense 15 { 16 Name = "许可证名称", 17 Url = new Uri("http://www./") 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 ” 按钮 好了,今天的在ASP.NET Core WebApi 3.0 中使用Swagger生成api说明文档教程就到这里了。希望能够对大家学习在ASP.NET Core中使用Swagger生成api文档有所帮助! 「开源NetCore,如果觉得我的文章对您有用,请帮助本站成长」 |
|
来自: python_lover > 《待分类》