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

一丶前言

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

 Swagger Github开源地址html

二丶思路

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

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

2.将json转化为html。json

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

三丶实现

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

效果以下:dom

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

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

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

如图:

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

是否是很熟悉。

最终效果:

 

四丶结语

到这就结束了,其实也没有啥难度,就是要花时间累代码。IT最让人着迷的就是开源了,没有比学习别人的代码成长更快的了,我也支持一下开源。最后再感谢一下园友 @老张的哲学 的帮助。

五丶Github Demo,演示地址

Demo 源码地址,顺便给个Star谢谢了。 

演示地址:http://gaobili.cn:8600/swagger/index.html

 

 加群一块儿学习共同进步。群号:963718093

.Net Core 开源学习交流

原文出处:https://www.cnblogs.com/HanJunJun-blog/p/10231180.html

相关文章
相关标签/搜索