在.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注入進去執行,如圖:
效果如下:
2.拿到swagger生成的文檔數據,我查閱了swagger github上的的源碼找到了他生成文檔的代碼,如下圖:
2.然后我們使用net core的ioc容器注入把這個對象注入到ioc容器中,以備后續使用它,如圖:
3.從ioc容器中取出對象使用,將json對象轉換為html,在將html轉換為需要導出的文件。
如圖:
這里用到了一個RazorEngine?,這是一個微軟封裝的模板引擎,最重要一點它可以脫離mvc使用,可以用它來定制自己的代碼生成器,個人認為它比T4好用,吐槽一下,T4的語法看著是真的別扭。。再看RazorEngine語法看著舒服多了。
是不是很熟悉。
最終效果:
?
四丶結語
到這就結束了,其實也沒有啥難度,就是要花時間累代碼。IT最讓人著迷的就是開源了,沒有比學習別人的代碼成長更快的了,我也支持一下開源。最后再感謝一下園友?@老張的哲學?的幫助。
五丶Github Demo,演示地址
Demo地址,順便給個Star謝謝了。?
演示地址:http://gaobili.cn:8600/swagger/index.html
原文地址:https://www.cnblogs.com/hjjblog/p/10231180.html
.NET社區新聞,深度好文,歡迎訪問公眾號文章匯總 http://www.csharpkit.com
總結
以上是生活随笔為你收集整理的在.Net Core WebAPI下给Swagger增加导出离线文档功能的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 使用Azure DevOps持续集成Gi
- 下一篇: Kubernetes初探[1]:部署你的