Fork me on GitHub

Integration with Micronaut OpenAPI

This plugin integrates with Micronaut OpenAPI to provide support for generating OpenAPI clients or servers.

The plugin adds a couple goals which can be used to generate code:

In both cases, the code is generated in your target directory and integrated into the build lifecycle. In particular, in case you are generating a server, the generated code will be interfaces that you will have to implement in your main sources.

Generating a client

In order to generate a client, the minimal thing to do is to configure a couple properties:

<properties>
   ...
   <micronaut.openapi.generate.client>true</micronaut.openapi.generate.client>
   <micronaut.openapi.definition>src/openapi/petstore.json</micronaut.openapi.definition>
</properties>

It is however recommended to define the packages which will be used for code generation:

<properties>
   ...
   <micronaut.openapi.generate.client>true</micronaut.openapi.generate.client>
   <micronaut.openapi.definition>src/openapi/petstore.json</micronaut.openapi.definition>
   <micronaut.openapi.invoker.package.name>com.mycompany.invoker</micronaut.openapi.invoker.package.name>
   <micronaut.openapi.api.package.name>com.mycompany.api</micronaut.openapi.api.package.name>
   <micronaut.openapi.model.package.name>com.mycompany.api</micronaut.openapi.model.package.name>
</properties>

The full list of configuration properties can be found here.

Generating a server

Generating a server can be done in a similar way to generating a client, except that the code which is generated for the server (not the model) is simply interfaces that you will have to implement:

<properties>
   ...
   <micronaut.openapi.generate.server>true</micronaut.openapi.generate.server>
   <micronaut.openapi.definition>src/openapi/petstore.json</micronaut.openapi.definition>
</properties>

We also recommended to define the packages which will be used for code generation:

<properties>
   ...
   <micronaut.openapi.generate.server>true</micronaut.openapi.generate.server>
   <micronaut.openapi.definition>src/openapi/petstore.json</micronaut.openapi.definition>
   <micronaut.openapi.controller.package.name>com.mycompany.controller</micronaut.openapi.controller.package.name>
   <micronaut.openapi.invoker.package.name>com.mycompany.invoker</micronaut.openapi.invoker.package.name>
   <micronaut.openapi.api.package.name>com.mycompany.api</micronaut.openapi.api.package.name>
   <micronaut.openapi.model.package.name>com.mycompany.api</micronaut.openapi.model.package.name>
</properties>

The full list of configuration properties can be found here.