Purpose

APICROSS is a tool to generate source code from OpenAPI 3.0 API specification.

Features

• Generates API Models with Jackson metadata and JsonNullable Jackson module for optional fields.
  Supports following tricky OpenAPI models features:
  • additionalProperties (See here)
  • oneOf, allOf (See here)
  • minProperties, maxProperties and required properties validation support.
• Generates API Requests Handlers (as interfaces for Spring Web MVC controllers):
  • Basic Spring Security support
  • Query parameters objects
  • IRead* interfaces to support Hexagonal architecture (See here)
• Files upload/download support (See here)
• Customization:
  • Customize API handler method names (See here)
  • Customize Java class property name for model fields
  • Grouping operations into API Handlers

Minimal Maven Plugin setup

    <build>
        <plugins>
            <plugin>
                <groupId>io.github.itroadlabs</groupId>
                <artifactId>apicross-maven-plugin</artifactId>
                <version>${project.version}</version>
                <executions>
                    <execution>
                        <id>generate-api-classes</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>generate-code</goal>
                        </goals>
                        <configuration>
                            <specUrl>file:///${project.basedir}/../api-specifications/api.yaml</specUrl>
                            <generatorClassName>io.github.itroadlabs.apicross.springmvc.SpringMvcCodeGenerator</generatorClassName>
                            <generatorOptions implementation="io.github.itroadlabs.apicross.springmvc.SpringMvcCodeGeneratorOptions">
                                <apiHandlerPackage>com.myapp.web.handlers</apiHandlerPackage>
                                <apiModelPackage>com.myapp.web.models</apiModelPackage>
                                <writeSourcesTo>${project.build.directory}/generated-sources/java</writeSourcesTo>
                            </generatorOptions>
                        </configuration>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>io.github.itroadlabs</groupId>
                        <artifactId>apicross-springmvc</artifactId>
                        <version>${project.version}</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

Maven Plugin Configuration Options

Common options

Spring MVC generator options