2015-12-01 25 views
2

我正在開發使用ASP.NET 4.6和API的Web API 2.到目前爲止,我已經使用了DTO的和DataAnnotations,看起來像下面這樣:Web API中的DataAnnotations驗證,如何在Swagger中顯示?

public class CustomerDTO 
{ 
    ... 
    [Required] 
    public string Name { get; set; } 

    [StringLength(20, ErrorMessageResourceName = "Error", ErrorMessageResourceType = typeof(Resources), MinimumLength = 6)] 
    public string DocumentNumber { get; set; } 
    ... 
} 

而且我會用我的DTO的像這樣:

[ResponseType(typeof(CustomerDTO))] 
public IHttpActionResult PostCustomer(CustomerDTO customer) 
{ 
    if (!ModelState.IsValid) 
    { 
     return BadRequest(ModelState); 
    } 
    ... 
} 

現在我被要求發佈第一版的API文檔。在做了一些研究之後,我發現了Swagger,所以我從NuGet獲得了Swashbuckle並開始玩它。順便提一下,令人驚歎的。

但我確實需要我的API的用戶知道哪些是某些參數的最大長度,哪些是必需的,等等。我如何讓Swagger顯示這些信息?

回答

0

您可以顯示自定義錯誤消息這樣

[Required(ErrorMessage = "Name is required")] 
public string Name { get; set; } 
0

看到here答案

[StringLength(10,MinimumLength = 5)] 公共字符串名稱{;設置;}

相關問題