io.micronaut.starter.template.api.starterApi.rocker.raw Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-starter-core Show documentation

Generates Micronaut applications

There is a newer version: 4.7.0

Show newest version

@import io.micronaut.starter.application.ApplicationType
@import java.util.List

@args (
    String micronautVersion,
    String serverURL
)

=== Micronaut Starter @micronautVersion (@serverURL)

Micronaut Starter generates example project for the Micronaut framework (https://micronaut.io).

The API is defined by the OpenAPI 3 specification @serverURL/swagger/views/swagger-ui/index.html

The primary API for generating application is @serverURL/create/{type}/{name}.

The application type can be one of the following:

+-----------------+------------------------------------------+
| ID              | Description                              |
+-----------------+------------------------------------------+
@for (ApplicationType type : ApplicationType.values()) {
| @String.format("%-" + 15 + "s",type.name()) | @String.format("%-" + 40 + "s",type.getDescription()) |
}
+-----------------+------------------------------------------+

The "name" can be whatever you choose.

Available query parameters include:

+-----------------+------------------------------------------+------------------------------+
| Parameter       | Description                              | Default value                |
+-----------------+------------------------------------------+------------------------------+
| build           | The build system                         | gradle                       |
| lang            | The target language                      | java                         |
| test            | The test framework                       | junit                        |
| features        | The features you wish to include         | defaults                     |
+-----------------+------------------------------------------+------------------------------+

To view the possible features and their descriptions visit:

@serverURL/application-types/{type}/features

=== Examples

To create a default application:

    $ curl @serverURL/create/DEFAULT/example -o example.zip

To create a Maven application:

    $ curl @serverURL/create/DEFAULT/example?build=maven -o example.zip

To create a Kotlin application:

    $ curl @serverURL/create/DEFAULT/example?lang=kotlin -o example.zip