2017-05-11 19 views
0

我有控制器可以接收SearchProfilesModel的對象。它由SearchProfiles數組和基類中的幾個屬性組成。 方法:Swagger ui .NET中的數組參數說明

[HttpGet] 
[ResponseType(typeof(List<UserSearchResult>))] 
[Route("SearchWithParams")] 
public async Task<HttpResponseMessage> 
    SearchWithParams([FromUri] SearchProfilesModel model) 
{ 
    // Some logic 
    return Request.CreateResponse(HttpStatusCode.OK, result); 
} 

模型類:

public class SearchProfilesModel : LoginRequiredModel 
{ 
    [Required] 
    [JsonProperty("search_profiles")] 
    public List<SearchProfileViewModel> ProfilesList { get; set; } 
} 

列表項類:

public class SearchProfileViewModel 
{ 
    [JsonProperty("name")] 
    public string Name { get; set; } 
    [JsonProperty("surname")] 
    public string Surname { get; set; } 
    [JsonProperty("facebook_id")] 
    public string FacebookId { get; set; } 
    [JsonProperty("email")] 
    public string Email { get; set; } 
} 

我真的使用揚鞭UI(swashbuckle LIB)來測試我的控制器,但是當它產生該方法的幫助頁面顯示如下: Help page

我的問題是 - 我可以以某種方式顯示參數中的列表項(來自SearchProfileViewModel)的結構?如果我可以 - 如何? P.S. - 對不起,我的英語,它不是我的母語。

+1

的可能的複製[說明使用揚鞭2.0複雜對象的數組](HTTP://計算器。 COM /問題/ 38088722 /描述-AN-陣列的複雜對象 - 使用-招搖-2-0) –

回答

0

您的對象的結構是在所產生的文檔,看看礦: http://swashbuckletest.azurewebsites.net/swagger/docs/v1

{ 
"swagger": "2.0", 
"info": {...}, 
"host": "swashbuckletest.azurewebsites.net", 
"schemes": [...], 
"paths": {...}, 
"definitions": { 
    "Data": { 
     "type": "object", 
     "properties": { 
      "integ": { 
       "format": "int32", 
       "type": "integer", 
       "example": 123 
      }, 
      "doub": { 
       "format": "double", 
       "type": "number", 
       "example": 9858.216 
      }, 
      "boolea": { 
       "type": "boolean" 
      }, 
      "guid": { 
       "format": "uuid", 
       "type": "string", 
       "example": "f5849915-43c8-434c-92a7-7383d1acb631" 
      }, 
      "date": { 
       "format": "date-time", 
       "type": "string" 
      } 
     } 
    }, 
...