Skip to content

docs: add swagger migration steps and common issue for lyo 6.0 migration #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
berezovskyi wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

docs: add swagger migration steps and common issue for lyo 6.0 migration #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs-new/eclipse_lyo/migration-5x-6x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,38 @@ Replace all Java EE dependencies with Jakarta EE equivalents:
</dependency>
```

#### 2.5 Swagger Dependencies (if using Swagger)

If the project integrates Swagger for OpenAPI documentation, the Swagger JAX-RS integration dependencies shall be updated to their Jakarta EE compatible counterparts (using the `-jakarta` artifact ID suffix):

```xml
<!-- OLD: Swagger dependencies (javax namespace) -->
<!--
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-jaxrs2</artifactId>
<version>${swagger.version}</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-jaxrs2-servlet-initializer-v2</artifactId>
<version>${swagger.version}</version>
</dependency>
-->

<!-- NEW: Swagger dependencies (jakarta namespace) -->
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-jaxrs2-jakarta</artifactId>
<version>${swagger.version}</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-jaxrs2-servlet-initializer-v2-jakarta</artifactId>
<version>${swagger.version}</version>
</dependency>
```

### Phase 3: Code Migration

#### 3.1 Package Name Changes
Expand Down Expand Up @@ -337,6 +369,13 @@ mvn package

**Solution:** Ensure all `javax.*` imports are changed to `jakarta.*` and dependencies are updated.

**Issue: NoClassDefFoundError for JAX-RS / javax classes during server startup (e.g. HttpHeaders)**

> java.lang.NoClassDefFoundError: javax/ws/rs/core/HttpHeaders
> at org.glassfish.jersey.server.model.IntrospectionModeller...

**Solution:** Ensure that the Swagger/OpenAPI dependencies are migrated to their Jakarta EE equivalents with the `-jakarta` suffix (e.g., `swagger-jaxrs2-jakarta` and `swagger-jaxrs2-servlet-initializer-v2-jakarta` instead of `swagger-jaxrs2` and `swagger-jaxrs2-servlet-initializer-v2`).

**Issue: Jersey injection problems**

> java.lang.IllegalStateException: ServiceLocator has been shut down
Expand Down
Loading