Asp.net 使用Swashbuckle记录模型属性
让Swashback生成传递到操作中的各个参数的描述非常容易,但是如果我传入这样的模型:Asp.net 使用Swashbuckle记录模型属性,asp.net,asp.net-web-api,swagger,swashbuckle,Asp.net,Asp.net Web Api,Swagger,Swashbuckle,让Swashback生成传递到操作中的各个参数的描述非常容易,但是如果我传入这样的模型: public void Put([FromUri] ViewModelTest viewModelTest) { } public class ViewModelTest { public int Id { get; set; } public string Name { get; set; } } 模型如下所示: public void Put([FromUri] ViewModel
public void Put([FromUri] ViewModelTest viewModelTest)
{
}
public class ViewModelTest
{
public int Id { get; set; }
public string Name { get; set; }
}
模型如下所示:
public void Put([FromUri] ViewModelTest viewModelTest)
{
}
public class ViewModelTest
{
public int Id { get; set; }
public string Name { get; set; }
}
是否有推荐的策略来填充模型的描述
这里有一个工作示例:
代码在GitHub上:
公共类ViewModelTest
{
///
///将使用的超级ID
///
/// 123
公共int SuperId{get;set;}
///
///谁需要名字?
///
///无名氏
公共字符串名称{get;set;}
…在您的Swagger配置(App_Start/SwaggerConfig.cs)中,您需要启用includexmlcomcomments谢谢您的回复,但该示例只传递了一个参数,如上所述,在控制器操作上方使用xml注释记录这一点相当容易。我想能够做的是记录模型的字段(POCO)这是传入的。下面是您的模型在xml注释中的样子:缺少最重要的页面:在工作示例中,请求URL返回时的样子是这样的
http://swashbuckletest.azurewebsites.net/api/TestEnum/1?viewModelTest.id=123&viewModelTest.name=Jim
但是有没有办法不在每个参数上使用型号名称eter?所以你基本上可以使用这样的URLhttp://swashbuckletest.azurewebsites.net/api/TestEnum/1?id=123&name=Jim
后续:我在这里找到了我的答案:。基本上我必须告诉它使用非限定形式[FromUri(Name=”“)]