Use LinkedHashMap instead of HashMap for Swagger dictionary type (Java codegen)?

Question

I'm using openapi 3.0.2, and the codegen plugin:

<groupId>io.swagger.codegen.v3</groupId>
<artifactId>swagger-codegen-maven-plugin</artifactId>
<version>3.0.14</version>

I'm using the swagger dictionary/hashmap type described here:

https://swagger.io/docs/specification/data-models/dictionaries/

openapi: "3.0.2"
...
Labels:
    type: object
    additionalProperties:
        type: string
        minLength: 1
    description:  A description.

When I generate Java code for this, it is modelled as a class which extends HashMap:

@ApiModel(description = "A description.")
@Validated
@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.SpringCodegen", date = "2020-02-26T12:17:36.248Z[Europe/London]")
public class Labels extends HashMap<String, String>  {
...
}

Is there any way to instruct swagger to use a LinkedHashMap instead of a HashMap? (without having to exclude this class from codegen and manually modify it).

I would like to control the ordering of the entries in this dictionary when returning it to clients.

Seems like this issue has been [closed on the swagger github](https://github.com/swagger-api/swagger-core/issues/2021), which would make the `LinkedHashMap` the default implementation — Lino, Feb 26 '20 at 12:36
Thanks @Lino, I did see that, but I have tried generating server code for a few different types now (spring, jaxrs-cs etc), and they all generate a class that extends HashMap — rmf, Feb 26 '20 at 13:20

score 1 · Accepted Answer · answered Mar 11 '20 at 16:27

I used a maven plugin to modify the generated file:

<plugin>
        <groupId>org.codehaus.gmavenplus</groupId>
        <artifactId>gmavenplus-plugin</artifactId>
        <executions>
                <execution>
                        <id>modify-swagger</id>
                        <phase>generate-sources</phase>
                        <goals>
                                <goal>execute</goal>
                        </goals>
                        <configuration>
                                <properties>
                                        <property>
                                                <name>targetDir</name>
                                                <value>${project.build.directory}</value>
                                        </property>
                                </properties>
                                <scripts>
                                        <script><![CDATA[
                                                def labelsFile = new File(targetDir
                                                                + "/swagger-codegen/src/main/java/com/acme/models/Labels.java")
                                                def labelsFileContents = labelsFile.text
                                                if (labelsFileContents == null) {
                                                        throw Exception();
                                                }

                                                def newLabelsFileContents = labelsFileContents.replaceAll('HashMap', 'LinkedHashMap')
                                                labelsFile.write(newLabelsFileContents)
                                        ]]></script>
                                </scripts>
                        </configuration>
                </execution>
        </executions>
</plugin>

score 0 · Answer 2 · answered Dec 07 '21 at 13:02

You can use instantiationTypes option:

        <plugin>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-codegen-maven-plugin</artifactId>
            <version>2.4.9</version>
            <configuration>
                <language>java</language>
            </configuration>
            <executions>
                <execution>
                    <id>generate-java</id>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                    <configuration>
                        <language>spring</language>
                        <instantiationTypes>map=java.util.LinkedHashMap</instantiationTypes>
                    </configuration>
                </execution>
            </executions>
        </plugin>

Use LinkedHashMap instead of HashMap for Swagger dictionary type (Java codegen)?

2 Answers2