具有 Microsoft.OData.Edm.Date 参数的 OData 函数，导致 Swashbuckle 出错

Question

我整合了Swashbuckle。OData 3.2.0和Swashbuckle。我的WepAPI OData webservice中的Core 5.5.3来生成Swagger documentaion。当我试图访问swaggerendpoint(http://localhost:52460/swagger)时，我得到了下面的异常，这似乎是由一个函数(AppointmentsForUsers)引起的，该函数采用了两个Microsoft类型的参数。OData.Edm.Date(不含时间成分的日期类型)。当我注释掉< code>var function = builder，function...在我的Register函数中，当我替换参数类型Microsoft时，一切都工作正常。OData.Edm.Date与系统。DateTimeOffset也很好，但这不是我们/我们项目的解决方案。

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        ODataModelBuilder builder = new ODataConventionModelBuilder();

        builder.EntitySet<UserDTO>("Users");
        builder.EntitySet<AppointmentDTO>("Appointments");

        var function = builder.Function("AppointmentsForUsers");
        function.ReturnsCollectionFromEntitySet<AppointmentDTO>("Appointments");
        function.Parameter<Date>("FromDate");
        function.Parameter<Date>("ToDate");
        function.CollectionParameter<int>("UserIds");

        config.MapODataServiceRoute(
            routeName: "odata",
            routePrefix: "odata",
            model: builder.GetEdmModel());
    }
}

public async Task<IHttpActionResult> AppointmentsForUsers(Date DateFrom, Date DateTo, Enumerable<int> UserIds) 
{
...
}

我在浏览器中得到的错误是：

500:｛“Message”：“发生错误。”，“ExceptionMessage”，“Der DateTimeOffset Text\”2015-12-12T12:00\“sollte das Format\”yyyy mm ddThh:mm:ss（'.s）？（zzzzzz）？\“aufweisen，und jeder Feldwert muss innerhalb des gültigen Bereichs liegen”，”ExceptionType“：”Microsoft.OData.ODataException“，”StackTrace“：”bei Microsoft.ODData.UriUtils.ConvertUriStringToDateTimeOffset（字符串文本，日期时间偏移

信息的德语部分

' der datetime offset-Text \ " 2015-12-12t 12:00 \ " sollte das Format \ " yyyy-mm-ddThh:mm:ss(' . 's)？(zzzzzz)？“好了，费尔德斯特先生一定要把一切都记在心里。”

表示：日期时间偏移量文本 \“2015-12-12T12：00\” 的格式应为 “yyyy-mm-ddThh：mm：ss（'）。s )?（zzzzzz）？\“，并且每个字段值必须在有效范围内

m DateTimeOffset-Wert '2015-12-12T12：00：00' fehlen die Zeitzoneninformationen.Ein DateTimeOffset-Wert muss Zeitzoneninformationen enthalten.”

意味着:DateTimeOffset值缺少时区信息。DateTimeOffset值必须包含时区信息。

这是个bug吗？除了不使用日期类型之外，还有其他解决方法吗？任何帮助都将不胜感激。

我还在Swashbuckle.Odata Github网站上打开了一个问题：https://github.com/rbeauchamp/Swashbuckle.OData/issues/134

更新：作为解决方法，我将参数类型更改为系统.日期时间

public async Task<IHttpActionResult> AppointmentsForUsers(DateTime DateFrom, DateTime DateTo, Enumerable<int> UserIds) 
{
...
}

有了这个解决方法，我仍然可以使用日期作为参数，例如约会用户（日期从=2017-04-07，……实际参数包含时间组件（取决于时区），但在内部我继续使用日期（从日期时间隐式转换）。至少对我们来说效果很好，尽管最初的问题仍然存在。

Answer 1

如果使用操作而不是函数可以成为解决方案…您是否尝试使用接收ODataActionParameter对象的操作作为此处描述的参数？：

https://learn . Microsoft . com/en-us/aspnet/we b-API/overview/odata-support-in-aspnet-we b-API/odata-v4/odata-actions-and-functions

public async Task<IHttpActionResult> AppointmentsForUsers(ODataActionParameters parameters) 
{
    Date fromDate = (Date)parameters["FromDate"];
    Date toDate = (Date)parameters["ToDate"];
    Enumerable[int] UserIds= (Enumerable[int])parameters["UserIds"];
}

另一种选择是创建一个包含三个参数的模型，并将其作为 ODataActionParameter 传递。

 var function = builder.Action("AppointmentsForUsers");
        function.ReturnsCollectionFromEntitySet<AppointmentDTO>("Appointments");
        function.Parameter<ModelWithDatesAndUsers >("Model");

public class ModelWithDatesAndUsers
{
    Date fromDate;
    Date toDate;
    Enumerable[int] userIds;
}

public async Task<IHttpActionResult> AppointmentsForUsers(ODataActionParameters parameters) 
{
         ModelWithDateAndUsers model= (ModelWithDatesAndUsers)parameters["Model"];        
}