.NET Core WebAPI使用Swagger生成api说明文档
2018-07-04 11:56
756 查看
版权声明:Copyright ©2018 Yang Hao Long,Harlan https://blog.csdn.net/yanghaolong/article/details/80909350
我们在平时Web API接口中正常使用Swagger,现在我使用.Net Core 开发Web API也同时使用了Swagger,Swagger就是最受欢迎的REST API文档生成工具之一,在这里我就大家简单说明一下如何在.Net Core 中使用Swagger。
一、为什么使用Swagger作为REST APIs文档生成工具
- Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。
- Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
- Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
- Swagger 有一个强大的社区,里面有许多强悍的贡献者。
二、 .Net Core中如何使用Swagger生成api说明文档呢
- Swashbuckle.AspNetCore 是一个开源项目,用于生成 .NET Core Web API 的 Swagger 文档。
- NSwag 是另一个用于将 Swagger UI 或 ReDoc 集成到 .NET Core Web API 中的开源项目。 它提供了为 API 生成 C# 和 TypeScript 客户端代码的方法。
三、下面以Swashbuckle.AspNetCore为例为大家进行展示
(1).Swashbuckle由哪些组成部分呢?
- Swashbuckle.AspNetCore.Swagger:将 SwaggerDocument 对象公开为 JSON 终结点的 Swagger 对象模型和中间件。
- Swashbuckle.AspNetCore.SwaggerGen:从路由、控制器和模型直接生成 SwaggerDocument 对象的 Swagger 生成器。 它通常与 Swagger 终结点中间件结合,以自动公开 Swagger JSON。
- Swashbuckle.AspNetCore.SwaggerUI:Swagger UI 工具的嵌入式版本。 它解释 Swagger JSON 以构建描述 Web API 功能的可自定义的丰富体验。 它包括针对公共方法的内置测试工具。
(2).如何使用vs2017安装Swashbuckle呢?
- 从“管理 NuGet 程序包”对话框中:
- 右键单击“解决方案资源管理器” > “管理 NuGet 包”中的项目
- 将“包源”设置为“nuget.org”
- 在搜索框中输入“Swashbuckle.AspNetCore”
- 从“浏览”选项卡中选择“Swashbuckle.AspNetCore”包,然后单击“安装”
(3.添加并配置 Swagger 中间件
首先引入命名空间:
using Swashbuckle.AspNetCore.Swagger;将 Swagger 生成器添加到 Startup.ConfigureServices 方法中的服务集合中:
public void ConfigureServices(IServiceCollection services) { services.AddMvc(); //注册Swagger生成器 services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Version = "v1", Title = "ShengZhen iCarNetCore API" }); //为 Swagger JSON and UI设置xml文档注释路径 //获取应用程序所在目录(绝对路径,不受工作目录影响,建议采用此方法获取路径使用windwos&Linux) var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location); var xmlPath = Path.Combine(basePath, "iCarNetCoreAPI.xml"); c.IncludeXmlComments(xmlPath); }); }在 Startup.Configure方法中,启用中间件为生成的 JSON 文档和 Swagger UI 提供服务:
//启用中间件服务生成Swagger作为JSON终结点 app.UseSwagger(); //启用中间件服务对swagger-ui,指定Swagger JSON终结点 app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "iCarNetCoreAPI接口文档"); });启动应用,并导航到
http://localhost:<port>/swagger/v1/swagger.json生成的描述终结点的文档显示如下json格式。
可在
http://localhost:<port>/swagger找到 Swagger UI, 通过 Swagger UI 浏览 API文档,如下所示:
要在应用的根 (
http://localhost:<port>/) 处提供 Swagger UI,请将
RoutePrefix属性设置为空字符串:
app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "iCarNetCoreAPI接口文档"); c.RoutePrefix = string.Empty; });
(4).Swagger的高级用法(自定义以及扩展)
A.使用Swagger为API文档增加说明信息
[p]在AddSwaggerGen方法的进行如下的配置操作会添加诸如作者、许可证和说明信息等:
public void ConfigureServices(IServiceCollection services) { services.AddMvc(); //注册Swagger生成器 services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Version = "v1", Title = "ShengZhen iCarNetCore API", Description = "NetCore API Introduce", TermsOfService = "None", Contact = new Contact { Name = "Yang Hao Long,Harlan", Email = string.Empty, Url = "https://blog.csdn.net/yanghaolong" }, License = new License { Name = "许可证名字", Url = "https://blog.csdn.net/yanghaolong" } }); //为 Swagger JSON and UI设置xml文档注释路径 //获取应用程序所在目录(绝对路径,不受工作目录影响,建议采用此方法获取路径使用windwos&Linux) var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location); var xmlPath = Path.Combine(basePath, "iCarNetCoreAPI.xml"); c.IncludeXmlComments(xmlPath); // c.OperationFilter<HttpHeaderOperation>(); // 添加httpHeader参数 // c.OperationFilter<ApiHttpHeaderFilter>(); // 添加httpHeader参数 }); }Swagger UI 显示版本的信息如下图所示:
B.为接口方法添加注释
大家先点击下api,展开如下图所示,可以没有注释啊,怎么来添加注释呢?[/p]C.启用XML 注释
可使用以下方法启用 XML 注释:
- 右键单击“解决方案资源管理器”中的项目,然后选择“属性”
- 查看“生成”选项卡的“输出”部分下的“XML 文档文件”框
- 启用 XML 注释后会为未记录的公共类型和成员提供调试信息。如果出现很多警告信息 例如,以下消息指示违反警告代码 1591:如果你有强迫症,想取消警告怎么办呢?可以按照下图所示进行取消.
注意: 1.对于 Linux 或非 Windows 操作系统,文件名和路径区分大小写。 例如,“iCarNetCoreAPI.xml”文件在 Windows 上有效,但在 CentOS 上无效。 2.获取应用程序路径,建议采用
Path.GetDirectoryName(typeof(Program).Assembly.Location)这种方式或者·AppContext.BaseDirectory这样来获取.按照下面所示添加文档注释,如下所示
/// <summary> /// 字符串返回操作POST /// </summary> /// <remarks> /// 例子: /// api/v1/PostOkResult/test /// </remarks> /// <param name="strValue">查询参数</param> /// <returns></returns> [HttpPost, Route("api/v1/PostOkResult")] public string ReturnString(string strValue) { return strValue + " Success"; }重新生成并运行项目查看一下注释出现了没有:
好了,今天的在.NET Core WebAPI使用Swagger生成api说明文档看这篇就够了的教程就到这里了。希望能够对大家学习在.NET Core中使用Swagger生成api文档有所帮助.
四、总结
本文从手工书写api文档的痛处说起,进而引出Swagger这款自动生成api说明文档的工具!然后通过通俗易懂的文字结合图片为大家演示了如何在一个.NET Core WebAPI中使用SwaggerUI生成api说明文档。最后又为大家介绍了一些.NET Core 中Swagger的一些高级用法!希望对大家在ASP.NET Core中使用Swagger有所帮助!
阅读更多相关文章推荐
- ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
- 使用Swagger来生成asp.net core Web API 文档
- 使用 Swagger 自动生成 ASP.NET Core Web API 的文档、在线帮助测试文档(ASP.NET Core Web API 自动生成文档)
- 使用 Swagger 自动生成 ASP.NET Core Web API 的文档、在线帮助测试文档(ASP.NET Core Web API 自动生成文档)
- Asp.net core WebApi 使用Swagger生成帮助页实例
- 在ASP.NET Core Web API上使用Swagger提供API文档
- Asp.net Core WebApi 使用Swagger做帮助文档,并且自定义Swagger的UI
- 在ASP.NET Core Web API上使用Swagger提供API文档
- 在ASP.NET Core Web API上使用Swagger提供API文档
- Asp.net core WebApi 使用Swagger生成帮助页实例
- 在ASP.NET Core Web API上使用Swagger提供API文档
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- asp.net core webapi swagger 使用二
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- 百度地图和高德地图坐标系的互相转换 四种Sandcastle方法生成c#.net帮助类帮助文档 文档API生成神器SandCastle使用心得 ASP.NET Core
- Asp .Net Core Web API的swagger 使用
- asp.net core webapi 使用swagger
- ASP.NET Core 中文文档 第二章 指南 (09) 使用 Swagger 生成 ASP.NET Web API 在线帮助测试文档
- ASP.NET MVC 5使用Swagger生成API文档
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档