.NetCore2.1 WebAPI 根据swagger.json自动生成客户端代码

前言

上一篇博客中我们可以得知通过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

640?wx_fmt=png

如上图框框选中的几点,我们需要留意。其中Swagger Specification URL就是我们WebAPI的swagger.json的在线地址。

如果点击【Create local Copy 】按钮时你的WebAPI未在线则代码生成工具会弹出错误对话框,如下图:

640?wx_fmt=png

 

 所以采取读取Swagger Specification URL 方式进行生成代码的前提条件是你必须保证swagger.json文件能在线读取!

 其次你可以选择RunTime(运行时),这里应该是服务端WebAPI的运行时(毕竟TypeScript是不关心你服务端是.NET Core还是.NET Framework).

因为我的环境是.NET Core2.1,所以这里选择NET Core21。

接下来,点击【Create local Copy】按钮,点击后NSwagStudio会与WebAPI服务端进行交互,成功后会将swagger.json文件格式化到左边的文本编辑器中,如下图:

640?wx_fmt=png

 

此时,你可以在右侧的Outputs中勾选你需要输出的文件格式,这里我选择TypeScript和CSharp Client,

这个地方有个C# WebAPI Controller,我有点纳闷,我都有swagger.json文件了绝壁是已经存在webapi了,

没有必要反向再去生成一遍webapi的控制器啦。 不懂,反正只管生成客户端代码就好。

我们勾选好后下面就会出现相应的输出配合页面,如下图:

640?wx_fmt=png

 

 

 我们选择CSharp Client页面,该页面左侧分为Setting和Output两个页面,Setting页可以对输出的cs文件进行配置,如命名空间、类名称、输出文件路径等等(很多配置我也不会....)

我们点击【Generate Outputs】后NSwagStudio会根据配置生成客户端操作类,在Output页面即可检查,检查无误后再点击【Generate Files】可将类文件导出到配置的输出目录。

TypeScript亦是如此,同时NSwagStudio也可支持加载DLL反射生成,具体方法可根据官网操作(毕竟可以直接使用json文件在线生成没必要再自己手工选择dll..)

 

这里截图看SwagerUI页和NSwagStudio生成后的客户端cs文件

640?wx_fmt=png

生成的客户端C#代码:

代码略,请阅读原文。

结语

不得不赞叹Swagger的强大,它的出现解放了多少程序员啊,后续但凡有客户端码农说不会调用哥的API,哥都可以直接给他代码生成器生成的代码,一个字:爽。

原文地址:https://www.cnblogs.com/hunanzp/p/9297361.html

.NET社区新闻,深度好文,欢迎访问公众号文章汇总 http://www.csharpkit.com

640?wx_fmt=jpeg

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/320835.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

BZOJ1485: [HNOI2009]有趣的数列

题解:考虑按顺序从小到大,加入数字,将加入奇数位置看作入栈,加入偶数位置看作出栈。为什么可以?考虑我们要保证相邻奇数小于偶数,所以必须先填上一个奇数的位置才能填偶数的位置,既时刻保证奇数…

jzoj4223-旅游【并查集】

正题 题目大意 nnn个点mmm条边&#xff0c;qqq次询问走边权小于xxx的能联通的点对数。 解题思路 将边权排序&#xff0c;然后并查集预处理答案即可。 时间复杂度O(mlog⁡m)O(m\log m)O(mlogm) codecodecode #include<cstdio> #include<cstring> #include<alg…

【dfs】买门票

买门票 题目大意&#xff1a; 给出一些字母&#xff0c;求出可组合成的组合&#xff08;要按顺序&#xff0c;和一定的规则&#xff09; 原题&#xff1a; 题目描述 mxy 正要经过新世界的大门。 现在有很多人在门口排队&#xff0c;每个人将会被发到一个有效的通行密码作为…

HDU1812 - Count the Tetris

polya自主ac的第一道&#xff0c;讨论方法&#xff1a;先把奇偶分开(1)顺时针0度&#xff0c;90度&#xff0c;180度&#xff0c;270度 (2)镜像竖线&#xff0c;水平线&#xff0c;两条对角线。分别推出公式计算&#xff0c;实在推不出来&#xff0c;写个模拟暴力找循环节&…

使用.NetCore 控制台演示 熔断 降级(polly)

1、熔断降级的概念&#xff1a; 熔断&#xff1a;我这里有一根长度一米的钢铁&#xff0c;钢铁的熔点1000度&#xff08;假设&#xff09;&#xff0c;现在我想用力把这根钢铁折弯&#xff0c;但是人的力有限达不到折弯的点&#xff0c;然后我使用火给钢铁加热&#xff0c;每隔…

I Got a Matrix!

I Got a Matrix! 题目大意&#xff1a; 给一个矩阵&#xff0c;求出边上的数的和 原题&#xff1a; 题目描述 给定一个 n ∗ m 的矩阵 A&#xff0c;询问位于矩阵边缘的元素之和。所谓矩阵边缘的元素&#xff0c;就是第一行和 最后一行的元素以及第一列和最后一列的元素。…

jzoj6803-NOIP2020.9.26模拟tom【构造】

正题 题目大意 nnn个点的一棵树&#xff0c;给每个点一个权值是1∼a1\sim a1∼a或−1∼−b-1\sim -b−1∼−b。每次选择正负中一个绝对值最小的删去使得无论如何选择都不会将树分成两个联通块。 解题思路 因为可以随意选择&#xff0c;所以aaa和−b-b−b的点一定要连在一起&am…

给正在努力的您几条建议(附开源代码)

前言我是一名在广州的某家互联网公司工作&#xff0c;并有6年工作经验&#xff0c;奔着架构师与微软MVP为目标的老鸟程序员。最近回顾了下多年来走的路&#xff0c;有不少的弯路。今天不说技术&#xff0c;而是总结了一些职业生涯上的建议与大家分享。虽说今天不说技术&#xf…

BZOJ3527: [Zjoi2014]力 [FFT]

化简之后&#xff0c;发现减号左边的式子是一个卷积。右边的式子&#xff0c;把一个函数倒序就是卷积&#xff0c;分别FFT&#xff0c;求解答案。 大佬blog: https://blog.csdn.net/kyleyoung_ymj/article/details/51721495 #include <bits/stdc.h> #define pi acos(-1.0…

jzoj6804-NOIP2020.9.26模拟jerry【dp】

正题 题目大意 nnn个数n−1n-1n−1个或−-−号的一个算式&#xff0c;加上一些括号使得运算结果最大。 解题思路 对于号左右的两个数字&#xff0c;无论如何加括号都不会变结果&#xff0c;所以我们可以合并这些数。然后就只剩下了减号&#xff0c;此时除了第一个就可以随意选…

.Net Core Cors中间件解析

同源策略和资源跨域共享1、同源策略同源策略&#xff0c;它是由Netscape提出的一个著名的安全策略。现在所有支持JavaScript 的浏览器都会使用这个策略。所谓同源是指&#xff0c;域名&#xff0c;协议&#xff0c;端口相同。1.1、目的主要是为了保证用户信息的安全&#xff0c…

BZOJ 3513: [MUTC2013]idiots [FFT]

统计每种长度的木棒数量&#xff0c;先计算出两根棒子能构成的长度&#xff0c;想到卷积。1.拿这个序列卷积自己 2.计算重算的部分&#xff0c;首先是一条边自己和自己的这种情况&#xff0c;另一种是(i,j)和(j,i)这种形式。第一种&#xff0c;可以枚举读入的木棒长度&#xff…

【暴力】I Liked Matrix!

I Liked Matrix! 题目大意&#xff1a; 有一个矩阵&#xff0c;求出某一些子矩阵内最大的数 原题&#xff1a; 题目描述 给定一个 n ∗ m 的矩阵 A&#xff0c;对其进行 q 次询问&#xff1a;以 (x1, y1) 为左上角&#xff0c;(x2, y2) 为右下角的子矩 阵中&#xff0c;所…

jzoj6805-NOIP2020.9.26模拟speike【扫描线】

正题 题目大意 一个平面上&#xff0c;起点是(0,0)(0,0)(0,0)&#xff0c;终点是(0,t)(0,t)(0,t)。有nnn个没有共同面积的矩形障碍物&#xff0c;对于每个障碍物不可以从内部穿过而可以从边上走过。求最短路。 解题思路 因为没有共同面积所以横坐标不会变小。并且只有在边界处…

【dfs】I Like Matrix!

I Like Matrix! 题目大意&#xff1a; 有一个矩阵&#xff0c;还有一些走法&#xff0c;从1,1开始可以走到多少个位置 原题&#xff1a; 题目描述 给定 k 种移动方式&#xff1a;从 (i, j) 移动到 (i xk, j yk)&#xff08;xk, yk > 0&#xff09;。询问在一个 n ∗ …

Full_of_Boys训练3总结

题目来源: 2016-2017 ACM-ICPC Pacific Northwest Regional Contest E.Enclosure 先计算出内外两个凸包&#xff0c;枚举大凸包上的点&#xff0c;在小凸包上找到两个切点。计算面积时&#xff0c;就相当于删掉几条原先的边&#xff0c;加上一个新的三角形。同时&#xff0c;可…

P3188-[HNOI2007]梦幻岛宝珠【背包】

正题 题目链接:https://www.luogu.com.cn/problem/P3188 题目大意 nnn个物品&#xff0c;大小为WWW的背包。 每个物品的大小可以表示为wiai2biw_ia_i2^{b_i}wi​ai​2bi​&#xff0c;有价值viv_ivi​。 求选择一些物品不超过背包的大小使得价值最大。 解题思路 设先计算bi…

【DP】I Will Like Matrix!

I Will Like Matrix! 题目大意&#xff1a; 有一个01矩阵&#xff0c;a[i][j1]a[i][j1]a[i][j1]和a[i1][j]a[i1][j]a[i1][j]必须大于a[i][j]a[i][j]a[i][j],问有多少种填法 原题&#xff1a; 题目描述 在一个 n ∗ m 的矩阵 A 的所有位置中分别填入 0 或 1&#xff0c;要求…

用Way.EntityDB进行Entity Framework Core数据库建模

Way.EntityDB是一个基于EF Core的数据层框架&#xff0c;它取消了EF Core的Migration机制&#xff0c;因为Migration并不是通用的&#xff0c;比如说sql server生成的migration&#xff0c;如果换成sqlite&#xff0c;运行时会报错的&#xff0c;也就是数据库不能更换。Way.Ent…

AT4513-[AGC030D]InversionSum【dp】

正题 题目链接:https://atcoder.jp/contests/agc030/tasks/agc030_d 题目大意 nnn个数&#xff0c;ppp次操作可以选择操作或者不操作&#xff0c;询问所有情况下逆序对的总和。 解题思路 转换成期望的问题&#xff0c;设fi,jf_{i,j}fi,j​表示所有情况下ai<aja_i<a_jai…