Swagger参数的默认值

Question

我如何在从下面的API生成的swagger中定义属性的默认值？

public class SearchQuery
{
        public string OrderBy { get; set; }

        [DefaultValue(OrderDirection.Descending)]
        public OrderDirection OrderDirection { get; set; } = OrderDirection.Descending;
}


public IActionResult SearchPendingCases(SearchQuery queryInput);

Swashbuckle生成OrderDirection作为所需参数。我希望它是可选的，并向客户机指示默认值（不确定swagger是否支持此选项）。

我不喜欢使属性类型为空。还有其他选择吗？理想情况下使用内置类...

我用的是虚张声势的皮带扣。AspNetCore-https://docs.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?tabs=visual-工作室

Answer 1

这适用于ASP。net MVC5，代码对.net Core无效

1-按如下方式定义自定义属性

public class SwaggerDefaultValueAttribute: Attribute
{
   public SwaggerDefaultValueAttribute(string param, string value)
   {
      Parameter = param;
      Value = value;
   }
   public string Parameter {get; set;}
   public string Value {get; set;}
}

2-定义一个Swagger操作Filter类

public class AddDefaulValue: IOperationFilter
{
   void IOperationFilter.Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
   {
      if (operation.parameters == null || !operation.parameters.Any())
      {
         return;
      }
      var attributes = apiDescription.GetControllerAndActionAttributes<SwaggerDefaultValueAttribute>().ToList();

      if (!attributes.Any())
      {
         return;
      }
      
      foreach(var parameter in operation.parameters)
      {
         var attr = attributes.FirstOrDefault(it => it.Parameter == parameter.name);
         if(attr != null)
         {
            parameter.@default = attr.Value;
         }
      }
   } 
}

3-在SwaggerConfig文件中注册OperationFilter

c.OperationFilter<AddDefaultValue>();

用属性装饰你的控制器方法

[SwaggerDefaultValue("param1", "AnyValue")]
public HttpResponseMessage DoSomething(string param1)
{
   return Request.CreateResponse(HttpStatusCode.OK);
}

Answer 2

如果您可以在控制器中设置默认参数值，则设置默认参数值的工作方式如下

// GET api/products
[HttpGet]
public IEnumerable<Product> Get(int count = 50)
{
    Conn mySqlGet = new Conn(_connstring);
    return mySqlGet.ProductList(count);
}

Answer 3

我总是像这样设置参数本身的默认值：

public class TestPostController : ApiController
{
    public decimal Get(decimal x = 989898989898989898, decimal y = 1)
    {
        return x * y;
    }
}

下面是它在swagger-ui上的样子:< br > http://swashbuckletest . azure websites . net/swagger/ui/index #/test post/test post _ Get

在对评论进行讨论之后，我更新了Swagger Net，通过反射读取＜code＞DefaultValueAttribute＜/code＞这里是我使用的示例类：

public class MyTest
{
    [MaxLength(250)]
    [DefaultValue("HelloWorld")]
    public string Name { get; set; }
    public bool IsPassing { get; set; }
}

这是swagger json的样子：

"MyTest": {
  "type": "object",
  "properties": {
    "Name": {
      "default": "HelloWorld",
      "maxLength": 250,
      "type": "string"
    },
    "IsPassing": {
      "type": "boolean"
    }
  },
  "xml": {
    "name": "MyTest"
  }
},

Swagger-Net的源代码在这里：
https://github.com/heldersepu/Swagger-Net

测试项目的源代码在这里：
https://github.com/heldersepu/SwashbuckleTest