Я использую SpringFox (Swagger) для документирования своих REST API. Одной из приятных функций Swagger является демонстрация примера модели и формата типа данных.
Теперь я настроил свои API для создания и использования дат в миллисекундах, но когда я смотрю на образец модели JSON, формат даты следующий: "2015-09-21T00:51:32.617Z". Смотрите скриншот ниже. Можно ли сказать SpringFox (Swagger), как правильно форматировать дату?
Вы можете попробовать:
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.apiInfo(getApiInfo())
.directModelSubstitute(YourDateTimeClass.class, Integer.class);
По сути, вы говорите Swagger заменить класс даты целым числом, которое может представлять миллисекунды.
Это связано с базовым сериализатором Jackson. Вы должны установить для него правильный формат даты, иначе по умолчанию он использует метки времени.
Вот пример конфигурации
@Configuration
public class WebConfiguration extends WebMvcConfigurerAdapter {
@Override
public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
for (HttpMessageConverter<?> converter : converters) {
if (converter instanceof MappingJackson2HttpMessageConverter) {
MappingJackson2HttpMessageConverter jsonMessageConverter = (MappingJackson2HttpMessageConverter) converter;
ObjectMapper objectMapper = jsonMessageConverter.getObjectMapper();
objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
break;
}
}
}
}
Таким образом, он будет использовать формат даты и времени ISO-8601. Вот еще одна запись в блоге, в которой объясняется, как установить собственный предпочтительный формат даты: http://yysource.com/2016/06/change-default-date-for-jackson-in-spring-boot-application/
У меня возникла проблема, аналогичная вашей, и я решил ее, добавив следующую конфигурацию в файл application.properties моего Spring Boot:
spring.jackson.date-format=com.fasterxml.jackson.databind.util.ISO8601DateFormat
