我正在使用 ASP.NET 4.6 和 Web API 2 开发 API。到目前为止,我一直在使用 DTO 和 DataAnnotations,如下所示:
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 显示此信息?