在.Net Core WebAPI下給Swagger增加導出離線文檔功能

来源:https://www.cnblogs.com/hjjblog/archive/2019/01/07/10231180.html
-Advertisement-
Play Games

一丶前言 最近剛接觸到Swagger,在github上下載了它的源碼和demo學習了一遍,發現這個組件非常好用,不過不足的是它沒有導出離線文檔的功能,於是乎我就想給它加一個導出功能 Swagger Github開源地址 二丶思路 其實說白了api文檔就是一個html靜態頁面,html可以轉word或 ...


一丶前言

  最近剛接觸到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

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 棧的ADT 數據 棧的數據對象集合為{a1,a2,a3...an},具有相同數據類型,有唯一前驅後續 操作 InitStack() Stack //初始化操作,創建一個空棧 Clear() //清空棧 IsEmpty() bool //棧是否為空,若棧為空,返回 true,否則 返回 false。 ...
  • HashMap JDK1.7 和1.8中關於對HashMap的實現,有了一些變化,其中很重要的一個變化,就是在解決Hash衝突的時候,存儲數據結構有所調整。 1.7版本: 主要實現方式: 通過數組+ 鏈表的方式實現。當hash衝突的時候,使用鏈表來解決衝突。但是當hash不均勻的時候,可能會導致數據 ...
  • 一. Hadoop Yarn 是什麼 在古老的 Hadoop1.0 中,MapReduce 的 JobTracker 負責了太多的工作,包括資源調度,管理眾多的 TaskTracker 等工作。這自然是不合理的,於是 Hadoop 在 1.0 到 2.0 的升級過程中,便將 JobTracker 的 ...
  • Python簡介 python的創始人為吉多·範羅蘇姆(Guido van Rossum)。1989年的聖誕節期間,吉多·範羅蘇姆(中文名字:龜叔)為了在阿姆斯特丹打發時間,決心開發一個新的腳本解釋程式,作為ABC語言的一種繼承。 Python是什麼編程語言 編程語言主要分為編譯型和解釋型,靜態語言 ...
  • 考慮在樹上選個點rt作為根,並且快遞中心就選這兒。計算出所有配送的代價(2 兩段之和),設他們的最大值為Max。若此時存在下列情況時,可以判定Max已經為最優解。 1)存在代價為Max的配送(u,v)且uv分別屬於rt的不同的兩個“兒子的子樹”。 2)存在代價為Max的配送(u1,v1)(u2,v2 ...
  • 什麼是內置函數? 就是python給你提供的,拿來直接用的函數, 比如print 和 input等等. 截止到python版本3.6.2 python一共提供了68個內置函數. 他們就是python直接提供給我們的,有一些我們已經見過了. 有一些還沒有見過. 還有一些需要學完了面向對象才能繼續學習的 ...
  • 1、volatile的作用 一個線程共用變數(類的成員變數、類的靜態成員變數等)被volatile修飾之後,就具有以下作用: 1)併發中的變數可見性(不同線程對該變數進行操作時的可見性),即一個線程修改了某個變數的值,則該新值對其他線程立即可見(可立即訪問新值/立即強制寫入主存); 2)禁止指令重排 ...
  • 1 private void ToExcel(string html) 2 { 3 4 Response.ContentType = "application/force-download"; 5 Response.AddHeader("content-disposition", 6 ... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...