[JAVA] Java-Types (BigDecimal, LocalDate, ...) are also effected by modelNamePrefixes and Suffixes

[d0x]

Description

When swagger is using Java-Types (BigDecimal, LocalDate, ...) as fields, those are also renamed.

In case modelNameSuffix is set to Dto, this will into Types like BigDecimalDto which is wrong.

This snipped is taken from the DefaultCodegen:

    /**
     * Output the proper model name (capitalized)
     *
     * @param name the name of the model
     * @return capitalized model name
     */
    public String toModelName(final String name) {
        return initialCaps(modelNamePrefix + name + modelNameSuffix);
    }

and this from AbstractJavaCodegen:

    @Override
    public String toModelName(final String name) {
        final String sanitizedName = sanitizeName(modelNamePrefix + name + modelNameSuffix);

        // camelize the model name
        // phone_number => PhoneNumber
        final String camelizedName = camelize(sanitizedName);

        // model name cannot use reserved keyword, e.g. return
        if (isReservedWord(camelizedName)) {
            final String modelName = "Model" + camelizedName;
            LOGGER.warn(camelizedName + " (reserved word) cannot be used as model name. Renamed to " + modelName);
            return modelName;
        }

        // model name starts with number
        if (name.matches("^\\d.*")) {
            final String modelName = "Model" + camelizedName; // e.g. 200Response => Model200Response (after camelize)
            LOGGER.warn(name + " (model name starts with number) cannot be used as model name. Renamed to " + modelName);
            return modelName;
        }

        return camelizedName;
    }

Swagger-codegen version

2.2.0-SNAPSHOT

Suggest a Fix

Use the typeMapper.values and ignore those.

I'll open a PR for this.

[ePaul]

Good catch, thanks.

[ePaul]

Do you have a test case where this happens (i.e. an OpenAPI definition + parameters to Codegen)?

[d0x]

You can reproduce it like this:

java -jar swagger-codegen-cli.jar generate --library feign --model-name-suffix Dto -i dtos.yaml

Where dtos.yaml should look like this:

swagger: '2.0'
info:
  title: Suffix on Types
  description: Shows that this doesn't work yet.
  version: "1.0.0"
paths:
  /example:
    get:
      summary: Product Types
      responses:
        200:
          description: An array of products
          schema:
            type: array
            items:
              $ref: '#/definitions/Example'
definitions:
  Example:
    type: object
    properties:
      product_id:
        type: string
      created:
        type: string
# Will be name DateTimeDto
        format: date-time
      low_estimate:
        type: number
      image:
        type: integer
# Will be name BigDecimalDto
        format: int32

It will look like this:

By investigating further I saw that my PR #3288 fixes the problem on the wrong place. It should be done in the AbstractJavaCodegen.getSwaggerType instead of AbstractJavaCodegen.toModelName and DefaultJavaCodegen.toModelName.

    @Override
    public String getSwaggerType(Property p) {
        String swaggerType = super.getSwaggerType(p);
        String type;
        if (typeMapping.containsKey(swaggerType)) {
            type = typeMapping.get(swaggerType);
            // Why we check only for this types when we have all TypeMappings at hand?
            if (languageSpecificPrimitives.contains(type) || type.indexOf(".") >= 0 ||
                type.equals("Map") || type.equals("List") ||
                type.equals("File") || type.equals("Date")) {
                return type;
            }
        } else {
            type = swaggerType;
        }
        if (null == type) {
            LOGGER.error("No Type defined for Property " + p);
        }
        return toModelName(type);
    }

What do you think? Should I let the DefaultCodegen like it is and remove this type.equals(...) checks within the AbstractJavaCodegen?