WebApiTestHelpPage

来源:https://www.cnblogs.com/gdnyfcuso/archive/2018/01/18/8308357.html
-Advertisement-
Play Games

這是個什麼鬼,第一次見到的時候,我也不知道就花幾天時間看了下它的代碼 在網上搜索WebApiTestHelpPage會出來很多相關頁面 但是它們都是介紹怎麼用的,要麼就是怎麼添加註釋 它是怎麼實現的,是什麼思想,為什麼這樣做,又是怎麼切入原來的系統並沒有講到 如果你只是想知道怎麼讓WebApiTes ...


 

這是個什麼鬼,第一次見到的時候,我也不知道就花幾天時間看了下它的代碼

 

在網上搜索WebApiTestHelpPage會出來很多相關頁面

 

但是它們都是介紹怎麼用的,要麼就是怎麼添加註釋

 

它是怎麼實現的,是什麼思想,為什麼這樣做,又是怎麼切入原來的系統並沒有講到

 

如果你只是想知道怎麼讓WebApiTestHelpPage出現在你的項目中

 

你可以參考:http://www.cnblogs.com/landeanfen/p/5210356.html

 

如果想處理多個項目之間的註釋問題

 

你可以參考:http://blog.csdn.net/aiwuzhi12/article/details/60465983

 

添加完項目之後:

 

生成文檔的相關代碼就在:helpPage這個Areas下具體如下圖

 

 

 

這個自動生成文檔的插件是怎麼實現的呢,是什麼樣的思想呢

 

正常情況下如果讓我們去做,我們會怎麼思考。

 

Web Api幫助頁面顯示的都是API介面的描述

 

那肯定要可以拿到WepApi的原數據才可以

 

就大概看了一下自動生成的代碼

 

根據以前經驗,如果要擴展一個系統,或者要學習一個框架

 

要看系統的配置,環境,

 

 

 

 

第一眼看到的就是HelpPageConfig 打開文件又只有一個方法

public static void Register(HttpConfiguration config)

 

類和方法都是靜態的

 

一般靜態的類方法用作對另一個系統的擴展,通過this關鍵字,委托註入到另一個系統

 

的核心對象

 

通過引用找到是誰調用了它,發現在 類

 

HelpPageAreaRegistration 的RegisterArea方法內調用了

HelpPageConfig.Register(GlobalConfiguration.Configuration);

 

那麼HelpPageAreaRegistration有什麼用呢,它實現了AreaRegistration 域註冊這個對象

並且重寫了它的抽象方法RegisterArea 這意味著只要繼承了AreaRegistration這個對象

被重寫的方法,在需要的時候都會調用到

 

那麼HelpPageAreaRegistration這個域註冊器是怎麼被調用到的呢

 

通過查找 發現AreaRegistration裡面有靜態的方法

 

         //

        // 摘要:

        //     註冊 ASP.NET MVC 應用程式中的所有區域。

        public static void RegisterAllAreas();

        //

        // 摘要:

        //     使用指定的用戶定義信息在 ASP.NET MVC 應用程式內註冊所有區域。

        //

        // 參數:

        //   state:

        //     一個包含要傳遞到區域中的用戶定義信息的對象。

        public static void RegisterAllAreas(object state);

  

 

也許有可能是程式啟動的時候,通過調用RegisterAllAreas這個方法,把其他的Area都註入到系統裡面來於是在

Global.asax這個文件裡面找到了

 

 

 

AreaRegistration.RegisterAllAreas();這行代碼

 

到此helpPage是被系統運行到的已經找到

 

再回顧一下,通過繼承AreaRegistration被系統找到,調用註冊RegisterArea的方法

 

然後在RegisterArea方法內部再初始化路由,初始helpPage的系統配置

 

HelpPageConfig這個內部到底是乾什麼的呢

 

方法內部調用了很多的擴展方法,這些擴展方法都被掛到了ASP.net的核心配置對象

 

HttpConfiguration 上

 

這個裡面可以拿到系統的很多信息比如HttpConfiguration. Services可以拿到所有系統預設的服務實例

 

         //

        // 摘要:

        //     獲取與此實例關聯的預設服務的容器。

        //

        // 返回結果:

        //     System.Web.Http.Controllers.ServicesContainer,包含此實例的預設服務。

        public ServicesContainer Services { get; }

  

 

通過調用ServicesContainer擴展方法

        / /

        // 摘要:

        //     獲取 System.Web.Http.Description.IApiExplorer 服務。

        //

        // 參數:

        //   services:

        //     服務容器。

        //

        // 返回結果:

        //     返回 System.Web.Http.Description.IApiExplorer 實例。

        public static IApiExplorer GetApiExplorer(this ServicesContainer services);

 

  

拿到當前系統的所有的API介面

這樣就可以在頁面上顯示出來

 

 

 

 

然後再通過用戶的點擊去查找具體的API介面信息

 

就在界面上看到瞭如下的結果

 

 


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

-Advertisement-
Play Games
更多相關文章
  • 最近在學習使用Webpack3的時候發現,它已經可以在不使用babel的情況下使用ES6的模塊載入功能了。 說到ES6的模塊載入功能,我們先複習一下CommonJS規範吧: 一 . CommonJS規範規定,在每個模塊內的module變數代表當前模塊。這個變數的module.exports屬性是對外 ...
  • input[type="button"], input[type="submit"], input[type="reset"] { -webkit-appearance: none; } textarea { -webkit-appearance: none;} 添加到css格式的文件中! ...
  • 1、7個“坑” 2、避免坑的原則 (1)如果兩邊有true或者false,千萬不要使用== (2)如果兩邊有[],''或者0,千萬不要使用== (3)最好都使用 ,來避免強制轉換的坑! ...
  • 原生js寫級動 首先先寫兩個<select>,第一級<select>裡邊填充你需要選擇的第一級項 第二個<select>,這裡後邊存放第二級選項 首先先建一個數組,將省對應的市全部填寫進去。 我們獲取第一級的對象和第二級對象,然後再返回當選中一級對象的時候索引值,然後再根據索引值找到第二級相對應的數 ...
  • 1:儘量減少AJAX的使用搜索引擎無法檢索ajax中的內容,也無法識別javascript代碼。 2:拒絕iframe,frame標簽iframe,frame會極大的阻礙搜索引擎爬取網站內容。 3:圖片中的文字搜索引擎無法識別儘量能夠把圖片中的文字獨立出來,這樣能夠滿足搜索引擎的抓取,提高搜索引擎的 ...
  • <!--css基礎之塊級元素和內聯元素 塊級元素的特點:1.占一整行。 2.是一個矩形。 3.可定義寬度和高度,內邊距,外邊距等。 4.其display屬性預設為block。 內聯元素的特點:1.並不占一整行,可併排。 2.依附於其他塊級元素存在,如果只有內聯元素,則依附body存在,body也是塊 ...
  • CSS(Cascading Style Sheets)規則由2個部分構成:選擇器,聲明。 selector{declaration1;declaration2;declaration3;...declarationN} declaration由分號(;)隔開,表示為 property:value1 ...
  • 在CSS中animation-delay的屬性為規定動畫何時開始。主機吧本文詳細介紹下animation-delay的定義和用法、animation-delay的語法、animation-delay的實例。 animation-delay屬性實例: 等待兩秒,然後開始動畫: animation-de ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...