如何在「請求和響應模型」中添加招搖評論？

您可以在像下面這個例子那樣的方法上添加註釋，但是如何在請求和響應模型中添加註釋？如何在「請求和響應模型」中添加招搖評論？

/// <summary> 
/// my summary 
/// </summary> 
/// <remarks> 
/// remark goes here. 
/// </remarks> 
/// <param name="somepara">Required parameter: Example: </param> 
/// <return>Returns comment</return> 
/// <response code="200">Ok</response>

來源

2017-07-19 001

是一樣貝爾巴托夫說，你可以添加註釋與SwaggerResponse響應，要求是有點不同的，就像你添加XML註釋到你的動作，你應該添加到的參數，下面是一個例子：

using Swagger.Net.Annotations; 
using System; 
using System.Collections.Generic; 
using System.Net; 
using System.Web.Http; 
using System.Web.Http.Results; 

namespace Swagger_Test.Controllers 
{ 
    public class IHttpActionResultController : ApiController 
    { 

     [SwaggerResponse(HttpStatusCode.OK, "List of customers", typeof(IEnumerable<int>))] 
     [SwaggerResponse(HttpStatusCode.NotFound, Type = typeof(NotFoundResult))] 
     public IHttpActionResult Post(MyData data) 
     { 
      throw new NotImplementedException(); 
     } 
    } 

    /// <summary>My super duper data</summary> 
    public class MyData 
    { 
     /// <summary>The unique identifier</summary> 
     public int id { get; set; } 

     /// <summary>Everyone needs a name</summary> 
     public string name { get; set; } 
    } 
}

而且在招搖，這將是這樣的：

來源

2017-07-19 13:37:23 HelderSepu

這裏是一個生動的例子： http://swashbuckletest.azurewebsites.net/swagger/ui/index?filter=IHttpActionResult#/IHttpActionResult/IHttpActionResult_Post – HelderSepu

這裏是代碼背後： https://github.com/ heldersepu/SwashbuckleTest/BLOB/eb89ab65a3e735f022104c153f2f7af21bc8bf48/Swagger_Test /控制器/ IHttpActionResultController.cs – HelderSepu

現在這個有趣的是我在所示的例子添加///

的唯一標識符

...就像但是說明沒有招搖的文檔顯示，我的模型是在一個單獨的項目（這是否重要？） – 001

我不知道這是你在談論什麼，但你可以這樣

[SwaggerResponse(HttpStatusCode.Unauthorized, "Authorization has been denied for this request")]

不同的響應添加註釋這是你用它來裝飾你的控制器的方法屬性。

來源

2017-07-19 10:40:11

添加響應的意見也可以使用XML來完成 - 響應代碼。 – Hezye

如何在「請求和響應模型」中添加招搖評論？

回答

相關問題