网页设计与制作课程相关信息,北京百度seo公司,c# 网站开发框架,珠海做网站哪家好前言上一篇博客中我们可以得知通过Swagger插件可以很方便的提供给接口开发者在线调试#xff0c;但是实际上Swagger附带的功能还有很多#xff0c;比如使用NSwag生成客户端调用代码#xff0c;进一步解放接口开发者。NSwag NSwag是一个发布在GitHub上的开源项目#xff0c;… 前言上一篇博客中我们可以得知通过Swagger插件可以很方便的提供给接口开发者在线调试但是实际上Swagger附带的功能还有很多比如使用NSwag生成客户端调用代码进一步解放接口开发者。NSwag NSwag是一个发布在GitHub上的开源项目它可以根据Swagger说明页上的swagger.json文件生成C#、TypeScript客户端代码。NSwag的项目地址:https://github.com/RSuter/NSwag Nswag提供4种代码生成方法1、使用 NSwagStudio这是一款 Windows 桌面应用用于在 C# 和 TypeScript 中为 API 生成客户端代码。2、使用 NSwag.CodeGeneration.CSharp 或 NSwag.CodeGeneration.TypeScript NuGet 包在项目中执行代码生成。3、使用命令行中的 NSwag。4、使用 NSwag.MSBuild NuGet 包。这里推荐使用NSwagStudio可以从GitHub上下载该工具地址:https://github.com/RSuter/NSwag/wiki/NSwagStudio下载后开始安装安装完毕后打开NSwagStudio如下图在左侧选择Tab页菜单里选择Documents如上图框框选中的几点我们需要留意。其中Swagger Specification URL就是我们WebAPI的swagger.json的在线地址。如果点击【Create local Copy 】按钮时你的WebAPI未在线则代码生成工具会弹出错误对话框如下图: 所以采取读取Swagger Specification URL 方式进行生成代码的前提条件是你必须保证swagger.json文件能在线读取 其次你可以选择RunTime运行时这里应该是服务端WebAPI的运行时(毕竟TypeScript是不关心你服务端是.NET Core还是.NET Framework).因为我的环境是.NET Core2.1所以这里选择NET Core21。接下来点击【Create local Copy】按钮点击后NSwagStudio会与WebAPI服务端进行交互成功后会将swagger.json文件格式化到左边的文本编辑器中如下图: 此时你可以在右侧的Outputs中勾选你需要输出的文件格式这里我选择TypeScript和CSharp Client这个地方有个C# WebAPI Controller我有点纳闷我都有swagger.json文件了绝壁是已经存在webapi了没有必要反向再去生成一遍webapi的控制器啦。 不懂反正只管生成客户端代码就好。我们勾选好后下面就会出现相应的输出配合页面如下图: 我们选择CSharp Client页面该页面左侧分为Setting和Output两个页面Setting页可以对输出的cs文件进行配置如命名空间、类名称、输出文件路径等等(很多配置我也不会....)我们点击【Generate Outputs】后NSwagStudio会根据配置生成客户端操作类在Output页面即可检查检查无误后再点击【Generate Files】可将类文件导出到配置的输出目录。TypeScript亦是如此同时NSwagStudio也可支持加载DLL反射生成具体方法可根据官网操作(毕竟可以直接使用json文件在线生成没必要再自己手工选择dll..) 这里截图看SwagerUI页和NSwagStudio生成后的客户端cs文件生成的客户端C#代码代码略请阅读原文。结语不得不赞叹Swagger的强大它的出现解放了多少程序员啊后续但凡有客户端码农说不会调用哥的API哥都可以直接给他代码生成器生成的代码一个字爽。原文地址https://www.cnblogs.com/hunanzp/p/9297361.html.NET社区新闻深度好文欢迎访问公众号文章汇总 http://www.csharpkit.com
