怎么在.Net Core WebAPI下给Swagger增加导出离线文档功能

发布时间:2022-01-17 18:44:08 作者:柒染
来源:亿速云 阅读:342

怎么在.Net Core WebAPI下给Swagger增加导出离线文档功能,很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。

一丶前言

  最近刚接触到Swagger,在github上下载了它的源码和demo学习了一遍,发现这个组件非常好用,不过不足的是它没有导出离线文档的功能,于是乎我就想给它加一个导出功能

 Swagger Github开源地址

二丶思路

其实说白了api文档就是一个html静态页面,html可以转word或者pdf,那问题就变简单了。

1.想办法拿到swagger生成的api接口json数据。

2.将json转化为html。

3.将html转换成word或者pdf等文件。

三丶实现

1.首先我们要解决第一个问题,要给Swagger的页面上加上导出按钮,Swagger提供了接口,我们可以用这个接口将js和css注入进去执行,如图:

怎么在.Net Core WebAPI下给Swagger增加导出离线文档功能

怎么在.Net Core WebAPI下给Swagger增加导出离线文档功能

效果如下:

怎么在.Net Core WebAPI下给Swagger增加导出离线文档功能

2.拿到swagger生成的文档数据,我查阅了swagger github上的的源码找到了他生成文档的代码,如下图:

怎么在.Net Core WebAPI下给Swagger增加导出离线文档功能

2.然后我们使用net core的ioc容器注入把这个对象注入到ioc容器中,以备后续使用它,如图:

怎么在.Net Core WebAPI下给Swagger增加导出离线文档功能

3.从ioc容器中取出对象使用,将json对象转换为html,在将html转换为需要导出的文件。

如图:

怎么在.Net Core WebAPI下给Swagger增加导出离线文档功能

这里用到了一个RazorEngine ,这是一个微软封装的模板引擎,最重要一点它可以脱离mvc使用,可以用它来定制自己的代码生成器,个人认为它比T4好用,吐槽一下,T4的语法看着是真的别扭。。再看RazorEngine语法看着舒服多了。

怎么在.Net Core WebAPI下给Swagger增加导出离线文档功能

是不是很熟悉。

最终效果:

怎么在.Net Core WebAPI下给Swagger增加导出离线文档功能

看完上述内容是否对您有帮助呢?如果还想对相关知识有进一步的了解或阅读更多相关文章,请关注亿速云行业资讯频道,感谢您对亿速云的支持。

推荐阅读:
  1. .NET Core WebAPI如何集成Swagger做接口管理
  2. 用vs2019加.net core如何创建WeiApi项目

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

swagger webapi

上一篇:WebClient中如何进行请求超时设置与异常处理

下一篇:Java怎么实现二叉搜索树的插入、删除功能

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》