2014-08-31 62 views
2

嗨,大家好,我有一個關於微軟Azure移動服務的問題。我想爲Azure移動服務門戶(URL <填寫名稱> .azure-mobile.net)上的文檔創建文檔,以便讓我的朋友知道自定義API在發出請求時應該執行的操作。我搜索了它,但我沒有找到任何東西,標準的C#樣式文檔沒有顯示任何內容。它必須能夠記錄它,因爲在網站上它告訴我沒有可用的文檔或排序。如何記錄Azure移動服務後端

+0

任何運氣找到解決這個「問題」?我也在努力記錄我的API,並認爲它不應該那麼難... – Matheus 2015-04-23 21:42:29

+0

不合作夥伴。下面的答案有點相關,因爲api管理基本上用於限制api調用和記錄該方面,然後這個方面比單獨的服務器更公開,在那裏你只能使用來自azure的主密鑰連接 – Citrus 2015-04-24 10:22:34

+0

另外,已經嘗試過doxygen類型的文檔,希望它會生成一些文檔,但沒有雪茄到目前爲止... – Citrus 2015-04-24 10:24:33

回答

1

在幫助頁面上顯示標準C#文檔非常簡單。


基本上這個:

/// <summary> 
    /// Creates a new user account. 
    /// </summary> 
    /// <param name="model">Object containing the basic information about the user.</param> 
    /// <returns>User with the basic data and the JWT token.</returns> 
    /// <exception cref="BusinessLogicException"> 
    /// Throws business exception if the user that is being created contains invalid data, such as invalid email, username and so on. 
    /// </exception> 
    public async Task<ResponseMessage<UserLogin>> Post(PostUserModel model) 
    { 
     ... 
    } 

要成爲這樣的:

API Help Page

所有你需要做的是:

  1. 右鍵點擊您的移動服務.NET項目項目(在Visual Studio中)
  2. 轉到屬性
  3. 檢查 「XML文檔文件」 複選框(圖像波紋管)

Properties Windows

更多幫助頁面定製選項,請按照此資源: http://www.codeproject.com/Articles/819848/Master-the-Managed-Azure-Mobile-Services-Backend

+0

謝謝你親愛的!對不起,延遲,但昨天是我再次遇到這一天 – Citrus 2015-12-21 15:52:38

0

嘗試Azure API管理。它將爲您的用戶創建一個開發人員門戶,其中包含文檔,測試控制檯等,還提供可提供分析,配額等的管理門戶。你可以找到更多的細節here

相關問題