Spring Boot SDK - Installation

​

1. Register the repository

<repositories>
  <repository>
    <id>gitlab-westyx-nexus</id>
    <url>https://gitlab.com/api/v4/projects/81979866/packages/maven</url>
  </repository>
</repositories>

repositories {
    maven {
        url = uri("https://gitlab.com/api/v4/projects/81979866/packages/maven")
    }
}

​

2. Add the dependency

<dependency>
  <groupId>dev.westyx.nexus</groupId>
  <artifactId>nexus-spring-boot-starter</artifactId>
  <version>0.15.0</version>
</dependency>

implementation("dev.westyx.nexus:nexus-spring-boot-starter:0.15.0")

​

Requirements

• Java 17 or newer. 17 is the baseline because Spring Boot 4.1 itself requires only 17; CI also runs the suite on JDK 21.
• Spring Boot 4.0 or newer - and Spring Boot 3.5 works too. The starter is built against 4.0, the oldest line still receiving open-source security patches (all of 3.x left support on 2026-06-30), and every pipeline run tests 3.5.16, 4.0.7 and 4.1.0. One artifact covers all three: there is no -boot3 / -boot4 variant and no framework version in the coordinates.
• Jackson - whichever major your framework brings (Jackson 2 on Spring Boot 3, Jackson 3 on Spring Boot 4). Both are declared <optional>, so the starter never adds a second JSON library to your classpath. See JSON values.
• (Auto-configured) Jackson and SLF4J - both already on the Spring Boot classpath

​

Verify the installation

nexus: client ready (key_type=sk, ttl=PT1M)

• Missing nexus.base-url and nexus.api-key in application.yml / application.properties - the starter is conditional on both being set
• A pre-existing NexusClient bean elsewhere - @ConditionalOnMissingBean causes the starter to back off when one is already registered
• Spring Boot version below 3.2

​

Verifying connectivity

curl -s \
  -H "X-Nexus-API-Key: wxs_..." \
  https://your-service.westyx.dev/v1/sync

curl -N \
  -H "X-Nexus-API-Key: wxs_..." \
  -H "Accept: text/event-stream" \
  https://your-service.westyx.dev/v1/stream

​

Troubleshooting

• Could not transfer artifact dev.westyx.nexus:nexus-spring-boot-starter - your Maven settings haven’t picked up the GitLab registry. Confirm the <repositories> block is in your pom.xml, not just ~/.m2/settings.xml. Repository declarations in pom.xml are local to the project; in settings.xml they need a matching <profile> to be active.
• 401 Unauthorized from the registry - the registry might be configured with an old path that’s no longer valid. Switch to the numeric-ID variant above.
• Bean not created at startup - check that nexus.base-url and nexus.api-key are both set; the auto-configuration uses @ConditionalOnProperty on both.