最近在用 .Net Core 作项目 css
了解到swagger 是一个不错的工具html
简单介绍一下程序员
在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来讲想必是件很痛苦的事情吧,但文档又必须写,并且文档的格式若是没有具体要求的话,最终完成的文档则彻底取决于开发者的心情。或者详细点,或者简单点。那么有没有一种快速有效的方法来构建api说明文档呢?答案是确定的, Swagger就是最受欢迎的REST APIs文档生成工具之一!sql
Swagger 能够生成一个具备互动性的API控制台,开发者能够用来快速学习和尝试API。json
Swagger 能够生成客户端SDK代码用于各类不一样的平台上的实现。c#
Swagger 文件能够在许多不一样的平台上从代码注释中自动生成。api
Swagger 有一个强大的社区,里面有许多强悍的贡献者。app
Swashbuckle.AspNetCore 是一个开源项目,用于生成 ASP.NET Core Web API 的 Swagger 文档。asp.net
NSwag 是另外一个用于将 Swagger UI 或 ReDoc 集成到 ASP.NET Core Web API 中的开源项目。 它提供了为 API 生成 C# 和 TypeScript 客户端代码的方法。工具
Swashbuckle.AspNetCore.Swagger:将 SwaggerDocument 对象公开为 JSON 终结点的 Swagger 对象模型和中间件。
Swashbuckle.AspNetCore.SwaggerGen:从路由、控制器和模型直接生成 SwaggerDocument 对象的 Swagger 生成器。 它一般与 Swagger 终结点中间件结合,以自动公开 Swagger JSON。
Swashbuckle.AspNetCore.SwaggerUI:Swagger UI 工具的嵌入式版本。 它解释 Swagger JSON 以构建描述 Web API 功能的可自定义的丰富体验。 它包括针对公共方法的内置测试工具。
从“程序包管理器控制台”窗口进行安装
转到“视图” > “其余窗口” > “程序包管理器控制台”
导航到包含 TodoApi.csproj 文件的目录
请执行如下命令 ·Install-Package Swashbuckle.AspNetCore
从“管理 NuGet 程序包”对话框中:
右键单击“解决方案资源管理器” > “管理 NuGet 包”中的项目
将“包源”设置为“nuget.org”
在搜索框中输入“Swashbuckle.AspNetCore”
从“浏览”选项卡中选择“Swashbuckle.AspNetCore”包,而后单击“安装”
首先引入命名空间:
using Swashbuckle.AspNetCore.Swagger;
将 Swagger 生成器添加到 Startup.ConfigureServices 方法中的服务集合中:
在 Startup.Configure
方法中,启用中间件为生成的 JSON 文档和 Swagger UI 提供服务:
启动应用,并导航到 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", "My API V1"); c.RoutePrefix = string.Empty; });
在 AddSwaggerGen
方法的进行以下的配置操做会添加诸如做者、许可证和说明信息等:
wagger UI 显示版本的信息以下图所示:
为了防止博客被转载后,不保留本文的连接,特地在此加入本文的连接:https://www.cnblogs.com/yilezhu/p/9241261.html
你们先点击下api,展开以下图所示,能够没有注释啊,怎么来添加注释呢?
按照下图所示用三个/添加文档注释,以下所示
而后运行项目,回到swaggerUI中去查看注释是否出现了呢
仍是没有出现,别急,往下看!
可以使用如下方法启用 XML 注释:
右键单击“解决方案资源管理器”中的项目,而后选择“属性”
查看“生成”选项卡的“输出”部分下的“XML 文档文件”框
启用 XML 注释后会为未记录的公共类型和成员提供调试信息。若是出现不少警告信息 例如,如下消息指示违反警告代码 1591:
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这样来获取
从新生成并运行项目查看一下注释出现了没有
经过上面的操做能够总结出,Swagger UI 显示上述注释代码的 <summary>
元素的内部文本做为api大的注释!
固然你还能够将 remarks 元素添加到 Get
操做方法文档。 它能够补充 <summary>
元素中指定的信息,并提供更可靠的 Swagger UI。 <remarks>
元素内容可包含文本、JSON 或 XML。 代码以下:
从新生成下项目,当好到SwaggerUI看到以下所示:
摘录自:https://www.cnblogs.com/yanbigfeg/p/9232844.html
接口使用者最关心的就是接口的返回内容和响应类型啦。下面展现一下201和400状态码的一个简单例子:
咱们须要在咱们的方法上添加:[ProducesResponseType(201)][ProducesResponseType(400)]
而后添加相应的状态说明:
最终代码应该是这个样子:
效果以下所示
下面咱们经过一个小例子经过SwaggerUI调试下接口吧
点击一个须要测试的API接口,而后点击Parameters左右边的“Try it out ” 按钮
在出现的参数文本框中输入参数,以下图所示的,输入参数2
点击执行按钮,会出现下面所示的格式化后的Response,以下图所示
好了,今天的在ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了的教程就到这里了。但愿可以对你们学习在ASP.NET Core中使用Swagger生成api文档有所帮助
转自 https://www.cnblogs.com/yilezhu/p/9241261.html