Swagger (or postman) about the parameter transfer method of date type

Preface ： Debugging interface is often used Swagger perhaps Postman, But it is easy to have problems when encountering date types .

post The request may report the following exception ：

Can not deserialize value of type java.util.Date from String "2020-08-01 00:00:00": not a valid representation (error: Failed to parse Date value '2020-08-01 00:00:00': Can not parse date "2020-08-01 00:00:00Z": while it seems to fit format 'yyyy-MM-dd'T'HH:mm:ss.SSS'Z'', parsing fails (leniency? null))

get The request may report the following exception ：

Failed to convert from type [java.lang.String] to type [@org.springframework.web.bind.annotation.RequestParam @io.swagger.annotations.ApiParam java.util.Date] for value '2020-08-12T06:25:39.929Z'; nested exception is java.lang.IllegalArgumentException

All in all, it's because JAVA The field that accepts the date in the code cannot recognize the date type passed by the debugging tool , Now let's solve this problem .

One .post request

Solution -1

Directly in accordance with the swagger The type of prompt is passed in ,swagger The default date format is as follows ：

But this approach needs attention , The time here is standard XML Schema Of " Date data format ”,T Yes, followed by “ Time ”.Z representative 0 The time zone , Or call it UTC Unify time （UTC General standard time ）. So if you want to receive the time you want , It is necessary to subtract 8 Hours . For example, the time you want is 2020-08-12 12:10:50, Then the time you need to send it is 2020-08-12T04:10:50.000Z.

Reference resources ：utc How to convert time into Beijing time

Solution -2

If you think the solution -1 The time format in this way is too troublesome , You can set JAVA The field in the code that accepts the date , Set the time format you are used to .

The setup code is as follows ( Add... To the field @JsonFormat annotation )：

public class AttendanceResultStatisticsQryParam {

    @ApiModelProperty(required = true,example = "1997-01-01 00:00:00",value = " date ")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date time;

}

After setting, you can follow yyyy-MM-dd HH:mm:ss Enter the time in this time format , as follows ：

  Solution -3

Reference resources ：Postman in POST Request delivery date Type parameter

Two .get request

get The requested date type parameter is relatively simple , stay Swagger and Postman The time format is ：2020/08/12 00:00:00.

Reference resources ：Postman in GET Request to pass in date Type parameter