Installation

The installation documentation will explain all the different possibilities to install the Sakura Boot openapi module to build an application using springdoc openapi documentation.

Prerequisites

See Requirements for prerequisites.

Maven

Maven is recommended for developers who never use both Maven and Gradle.

Predefined dependencies

To install with predefined dependencies for a production-ready application, add one starter to the project dependencies:

This includes all the modules of sakura boot, the necessary spring boot starter, mapstruct, ehcache3 as cache provider, and a runtime postgresql.

<dependency>
    <groupId>org.sansenshimizu.sakuraboot</groupId>
    <artifactId>sakura-boot-starter-predefined-all-module</artifactId>
    <version>0.1.1</version>
</dependency>

Custom dependencies

To install with custom dependencies, add one starter to the project dependencies:

This includes all the modules of sakura boot.

<dependency>
    <groupId>org.sansenshimizu.sakuraboot</groupId>
    <artifactId>sakura-boot-starter-all-module</artifactId>
    <version>0.1.1</version>
</dependency>

Test dependencies

The test dependencies are available for unit tests, integration tests, and functional tests.
Integration and functional tests are available both with predefined starter and custom starter. There is no predefined starter for unit test.

Predefined dependencies

To install with predefined dependencies for a production-ready application, add one starter to the project dependencies:

Functional tests

This includes all the modules of sakura boot, the necessary spring boot starter, mapstruct, and a runtime postgresql test container.

<dependency>
    <groupId>org.sansenshimizu.sakuraboot</groupId>
    <artifactId>sakura-boot-starter-predefined-all-module-functional-test</artifactId>
    <version>0.1.1</version>
    <scope>test</scope>
</dependency>
Integration tests

This includes all the modules of sakura boot, the necessary spring boot starter, mapstruct, and a runtime h2 in-memory database.

<dependency>
    <groupId>org.sansenshimizu.sakuraboot</groupId>
    <artifactId>sakura-boot-starter-predefined-all-module-integration-test</artifactId>
    <version>0.1.1</version>
    <scope>test</scope>
</dependency>

Custom dependencies

To install with custom dependencies, add one starter to the project dependencies:

Functional tests

This includes all the modules of sakura boot.

<dependency>
    <groupId>org.sansenshimizu.sakuraboot</groupId>
    <artifactId>sakura-boot-starter-all-module-functional-test</artifactId>
    <version>0.1.1</version>
    <scope>test</scope>
</dependency>
Integration tests

This includes all the modules of sakura boot.

<dependency>
    <groupId>org.sansenshimizu.sakuraboot</groupId>
    <artifactId>sakura-boot-starter-all-module-integration-test</artifactId>
    <version>0.1.1</version>
    <scope>test</scope>
</dependency>
Unit tests

This includes all the modules of sakura boot.

<dependency>
    <groupId>org.sansenshimizu.sakuraboot</groupId>
    <artifactId>sakura-boot-starter-all-module-unit-test</artifactId>
    <version>0.1.1</version>
    <scope>test</scope>
</dependency>

Customisation

For more fine-grained control over dependencies, import directly from the openapi module and don’t use starters:

This includes the openapi module of sakura boot and only necessary dependencies (e.g., spring-core, springdoc-openapi, etc).

<dependency>
    <groupId>org.sansenshimizu.sakuraboot</groupId>
    <artifactId>sakura-boot-openapi</artifactId>
    <version>0.1.1</version>
</dependency>

And for the test modules, the different artifactId are the following:

  • sakura-boot-openapi-test

  • sakura-boot-integration-test

  • sakura-boot-functional-test

Gradle

Predefined dependencies

To install with predefined dependencies for a production-ready application, add one starter to the project dependencies:

This includes all the modules of sakura boot, the necessary spring boot starter, mapstruct, ehcache3 as cache provider, and a runtime postgresql.

implementation("org.sansenshimizu.sakuraboot:sakura-boot-starter-predefined-all-module:0.1.1")

Custom dependencies

To install with custom dependencies, add one starter to the project dependencies:

This includes all the modules of sakura boot.

implementation("org.sansenshimizu.sakuraboot:sakura-boot-starter-all-module:0.1.1")

Test dependencies

The test dependencies are available for unit tests, integration tests, and functional tests.
Integration and functional tests are available both with predefined starter and custom starter. There is no predefined starter for unit test.

Predefined dependencies

To install with predefined dependencies for a production-ready application, add one starter to the project dependencies:

Functional tests

This includes all the modules of sakura boot, the necessary spring boot starter, mapstruct, and a runtime postgresql test container.

functionalTestImplementation("org.sansenshimizu.sakuraboot:sakura-boot-starter-predefined-all-module-functional-test:0.1.1")
Integration tests

This includes all the modules of sakura boot, the necessary spring boot starter, mapstruct, and a runtime h2 in-memory database.

integrationTestImplementation("org.sansenshimizu.sakuraboot:sakura-boot-starter-predefined-all-module-integration-test:0.1.1")

Custom dependencies

To install with custom dependencies, add one starter to the project dependencies:

Functional tests

This includes all the modules of sakura boot.

functionalTestImplementation("org.sansenshimizu.sakuraboot:sakura-boot-starter-all-module-functional-test:0.1.1")
Integration tests

This includes all the modules of sakura boot.

integrationTestImplementation("org.sansenshimizu.sakuraboot:sakura-boot-starter-all-module-integration-test:0.1.1")
Unit tests

This includes all the modules of sakura boot.

testImplementation("org.sansenshimizu.sakuraboot:sakura-boot-starter-predefined-all-module-unit-test:0.1.1")

Customisation

For more fine-grained control over dependencies, import directly from the openapi module and don’t use starters:

This includes the openapi module of sakura boot and only necessary dependencies (e.g., spring-core, springdoc-openapi, etc).

implementation("org.sansenshimizu.sakuraboot:sakura-boot-openapi:0.1.1")

And for the test modules, the different artifactId are the following:

  • sakura-boot-openapi-test

  • sakura-boot-integration-test

  • sakura-boot-functional-test