Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Springfox 3.0.0 generates 3 classes instead of 1 (Class, ClassReq, ClassRes) and ClassReq is missing required fields

See original GitHub issue

What version of the library are you using? 3.0.0

For a single class 3.0.0 generates 3 classes: the original class, one with the Req and one with the Res postfix. Req seems to be used if @RequestBody is being used. Res I suppose when @ResponseBody is in use (do not use it, class is still generated). The original Class name is used when the class is present on another object.

This makes it impossible to pass a response object to a request API in Java and other other languages that rely on nominal typing because they are completely separate classes.

Even worse: it seems that the ParsedBusinessScheduleReq object does not properly generate the required fields. Below is the used class. Take a look at the required field which is absent for the ParsedBusinessScheduleReq object.

@ApiModel(value = "ParsedBusinessSchedule")
data class OpeningHours(
    val daysInWeek: List<WeeklyOpeningHours> = emptyList(),
    val daysInYear: List<YearlyOpeningHours> = emptyList(),
    val winterSeason: WinterSeason? = null,
    val closedOnHoliday: Boolean = true
)

{
  "ParsedBusinessSchedule": {
    "type": "object",
    "required": [
      "closedOnHoliday",
      "daysInWeek",
      "daysInYear"
    ],
    "properties": {
      "closedOnHoliday": {
        "type": "boolean"
      },
      "daysInWeek": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/WeeklyOpeningHours"
        }
      },
      "daysInYear": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/YearlyOpeningHours"
        }
      },
      "winterSeason": {
        "$ref": "#/definitions/WinterSeason"
      }
    }
  },
  "ParsedBusinessScheduleReq": {
    "type": "object",
    "properties": {
      "closedOnHoliday": {
        "type": "boolean"
      },
      "daysInWeek": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/WeeklyOpeningHoursReq"
        }
      },
      "daysInYear": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/YearlyOpeningHoursReq"
        }
      },
      "winterSeason": {
        "$ref": "#/definitions/WinterSeasonReq"
      }
    }
  },
  "ParsedBusinessScheduleRes": {
    "type": "object",
    "required": [
      "closedOnHoliday",
      "daysInWeek",
      "daysInYear"
    ],
    "properties": {
      "closedOnHoliday": {
        "type": "boolean"
      },
      "daysInWeek": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/WeeklyOpeningHoursRes"
        }
      },
      "daysInYear": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/YearlyOpeningHoursRes"
        }
      },
      "winterSeason": {
        "$ref": "#/definitions/WinterSeasonRes"
      }
    }
  }
}