webAPI 自動生成幫助文件

2022-03-01 02:18:15 字數 536 閱讀 2175

**

1、下圖展示的是生成幫助文件首頁面,其中values是controller,api下面的列表展示出請求的http方法(get,post等),請求的action,方法的描述。

3、點選test api開啟如下頁面

設定的方法步驟如下:

開發環境vs2012 + mvc4 + web api

1、通過nuget引用web api test client

或者通過nuget控制台輸入install-package webapitestclient

這裡面就是我們的幫助文件介面

2、在專案屬性中進行如下設定,勾選xml文件檔案,並設定路徑

ps:在錯誤和警告-禁止顯示警告填上1591,即可不顯示缺少對公共可見型別或成員****的xml注釋

WebApi 生成幫助文件及順便建立簡單的測試工具

下面開始幹活 一 建立 webapi 專案 二 找到 helppageconfig.cs 並取消 注釋 三 對專案單擊右鍵,選擇屬性,按圖操作 四 啟動專案,輸入url localhost help 注 description 沒有顯示內容是因為我們沒有在對應的方法上面以 的形式進行注釋 下面是順便...

Swagger生成WebAPI文件

webapi2.0 專案可以使用swagger能夠輕易檢視api文件,檢視以下配置 1.開啟程式包管理控制台輸入 c.includexmlcomments然後進行替換 c.includexmlcomments getxmlcommentspath thisassembly.getname name ...

Sandcastle生成幫助文件

準備條件 一 sandcastle help file builder help file builder and tools v2014.5.31.0 二 htmlhelp1 安裝完成後,進行操作。如下 1.開啟scandcastle檔案 選擇框架版本,以及要編譯的 dll檔案 2.修改其它配置 ...