(給DotNet加星标,提升.Net技能)
轉自:韓俊俊
cnblogs.com/hjjblog/p/10231180.html
一、前言
最近剛接觸到Swagger,在github上下載下傳了它的源碼和demo學習了一遍,發現這個元件非常好用,不過不足的是它沒有導出離線文檔的功能,于是乎我就想給它加一個導出功能。
Swagger Github開源位址:https://github.com/domaindrivendev/Swashbuckle.AspNetCore
二、思路
其實說白了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上的的源碼找到了他生成文檔的代碼,如下圖:
3、然後我們使用net core的ioc容器注入把這個對象注入到ioc容器中,以備後續使用它,如圖:
4、從ioc容器中取出對象使用,将json對象轉換為html,在将html轉換為需要導出的檔案。如圖:
這裡用到了一個RazorEngine
(https://blog.csdn.net/xue251248603/article/details/77085486) ,這是一個微軟封裝的模闆引擎,最重要一點它可以脫離mvc使用,可以用它來定制自己的代碼生成器,個人認為它比T4好用,吐槽一下,T4的文法看着是真的别扭。
再看RazorEngine文法看着舒服多了。
是不是很熟悉。
最終效果:
四、結語
到這就結束了,其實也沒有啥難度,就是要花時間積累代碼。IT最讓人着迷的就是開源了,沒有比學習别人的代碼成長更快的了,我也支援一下開源。
五、Github Demo
示範位址:http://gaobili.cn:8600/swagger/index.html
Demo位址:https://github.com/HanJunJun/Titan.Blog.WebAPP
(順便給個Star謝謝了)
推薦閱讀
(點選标題可跳轉閱讀)
ASP.NET Core WebAPI使用Swagger生成API文檔
.NET Core使用Swagger進行API接口文檔管理
.NET Core小技巧使用Swagger上傳檔案
看完本文有收獲?請轉發分享給更多人
關注「DotNet」加星标,提升.Net技能
喜歡就點一下「好看」呗~