为Java LocalDateTime生成正确的swagger规范

Question

我试图在spring boot应用程序中使用swagger注释从Java代码中获取swagger规范（yaml）。我对模型进行注释，然后运行springboot应用程序，然后从http://localhost:8080/v2/api-文档。

我的模型如下所示：

package com.indiana.core;
import java.time.LocalDateTime;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonProperty;

import io.swagger.annotations.ApiModelProperty;

@lombok.ToString
@lombok.Getter
@lombok.Setter
public class SampleClass{

        @JsonProperty(value = "birth_date_time")
    private LocalDateTime birthDateTime;
....
}'

我想为此创建正确的swagger yaml斑点。当我访问自动提供yaml的swagger UI时，我期待下面的内容。

注意dateOfBirth是一个Java 8 LocalDateTime类(https://swagger.io/specification/查找数据类型部分）yaml中的日期应为类型：“string”，格式为：Date-time。

 'SampleClass:
    properties:
      dateOfBirth:
        type: string
        format: date-time'

我现在得到的是：

看起来swagger正在构建一个详细的定义LocalDateTime，这不是我要找的。

'"definitions": {
        "LocalDateTime": {
            "type": "object",
            "properties": {
                "chronology": {
                    "$ref": "#/definitions/Chronology"
                },
                "dayOfMonth": {
                    "type": "integer",
                    "format": "int32"
                },
                "dayOfWeek": {
                    "type": "string",
                    "enum": ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
                },
                "dayOfYear": {
                    "type": "integer",
                    "format": "int32"
                },
                "hour": {
                    "type": "integer",
                    "format": "int32"
                },
                "minute": {
                    "type": "integer",
                    "format": "int32"
                },
                "month": {
                    "type": "string",
                    "enum": ["JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"]
                },
                "monthValue": {
                    "type": "integer",
                    "format": "int32"
                },
                "nano": {
                    "type": "integer",
                    "format": "int32"
                },
                "second": {
                    "type": "integer",
                    "format": "int32"
                },
                "year": {
                    "type": "integer",
                    "format": "int32"
                }
            }
        },

我试过了

'A. @ApiModelProperty(dataType = "java.lang.String", example = "17-03-2019 22:18:59", notes = "Birthdaytime desc")
B. @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "MM-dd-yyyy hh:mm:ss")'

对于A，元素仅在yaml中定义为字符串，缺少“form： date-time”，如下所示。

 SampleClass:
    properties:
      dateOfBirth:
        type: string

需要做什么调整才能创建一个完美的swegger？我需要这个

 SampleClass:
    properties:
      dateOfBirth:
        type: string
        format: date-time .

Answer 1

只需在LocalDateTime字段上添加以下注释，以在swagger定义中格式化datetime：

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", shape = Shape.STRING)
@ApiModelProperty(required = true, example = "2021-08-20T00:00:00")