2012-12-08 59 views
0

我剛開始第一次使用swagger,似乎無法弄清楚如何通過Xml Documention註釋獲取實現註釋以顯示任何內容。Swagger.net - 如何在xml註釋中指定UI註釋

我已經瀏覽了幾個小時的文檔,沒有看到任何提及如何填充json輸出中的特定字段。

我希望這個動態完成,不想爲這個數據創建一個靜態json文件 有沒有關於指定哪些字段來獲得某些輸出的教程或附加文檔。

而且是有

編輯顯示從在所述UI輸出動作方法的輸入模型基於一個樣品JSON請求,而不必用手來顯示這些的方法:

此外另一個問題我今天來accross是如果我有一個簡單的get方法標記爲Authorize Swagger UI完全中斷,並且當我嘗試添加Authorize標頭(我使用持票人標記)時,javascript api中的標頭選項授權令牌永遠不會發送 代碼是a如下

 $(function() { 
     window.swaggerUi = new SwaggerUi({ 
      discoveryUrl: "/api/swagger", 
      dom_id: "swagger-ui-container", 
      docExpansion: 'list', 
      headers: { "Authorization":"Bearer Y2xtY2dyYXRoX2ZhY19jcmRJQ1RHV1MuQ29vcmRpbmF0b3IsRmFjdWx0eS42RC1BMi02Mi03Mi00Qi00Mg=="}, 
      supportHeaderParams: true, 
      supportedSubmitMethods: ['get', 'post', 'put', 'delete'] 

     }); 


     window.swaggerUi.load(); 

    }); 

當我在我的消息處理程序中收到請求時,authHeader爲空,並且根本不存在於標頭集合中,並且不記名令牌一直運行良好,直到現在使用Fiddler 是否有某些事情發生在swagger api中,需要做的事情,我想念我已經遵循文件幾乎確切的信件和上面的功能工作正常以外的身份驗證,我不知道如何填充執行備註

回答

4

source code,它看起來像實現註釋由您的評論的<備註/ >元素提供。例如:

/// <summary> 
/// Gets the resource by the specified ID. 
/// </summary> 
/// <param name="id">The id.</param> 
/// <remarks>These remarks end up in the implementation notes of swagger</remarks> 
public string Get(int id) 
{ 
    return "my resource at " + id; 
} 
+0

我希望swagger-client.js也有Implementaton註釋。只有swagger-ui.js有這個。 – agentpx