使用 Swashbuckle 记录模型属性

Question

让 swashbuckle 生成传递给操作的各个参数的描述非常容易，但是如果我传递这样的模型：

public void Put([FromUri] ViewModelTest viewModelTest)
{
}

模型看起来像这样：

public class ViewModelTest
{
    public int Id { get; set; }

    public string Name { get; set; }
}

是否有推荐的填充模型描述的策略？

Answer 1

这是一个工作示例：
http://swashbuckletest.azurewebsites.net/swagger/ui/index#!/TestEnum/TestEnum_Put

代码在 GitHub:
https://github.com/heldersepu/Swagger-Net-Test/blob/master/Swagger_Test/Models/ViewModelTest.cs

public class ViewModelTest
{
    /// <summary>
    /// The super ID that will be used
    /// </summary>
    /// <example>123</example>
    public int SuperId { get; set; }

    /// <summary>
    /// Who needs a name?
    /// </summary>
    /// <example>John Doe</example>
    public string Name { get; set; }

...并且在您的 Swagger 配置 (App_Start/SwaggerConfig.cs) 中，您需要启用 IncludeXmlComments

使用 Swashbuckle 记录模型属性

Using Swashbuckle to document model properties

asp.net

asp.net-web-api

swagger

swashbuckle