Migrate from Springfox to SpringDoc OpenAPI for Java 11 compatibility #54
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Remove springfox-swagger2 (2.9.2) and springfox-swagger-ui (2.10.0) dependencies - Add springdoc-openapi-ui (1.7.0) dependency - Delete ApplicationConfig.java (Springfox configuration) - Remove Springfox annotations from AccountController and CustomerController - SpringDoc auto-generates OpenAPI v3 documentation from Spring Web annotations Verified: - Build passes: mvn clean install - Application starts successfully on port 8989 - Swagger UI accessible at http://localhost:8989/bank-api/swagger-ui/index.html - All endpoints properly documented in OpenAPI v3 format Co-Authored-By: Jaime Mizrachi <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
devin-ai-integration
bot
changed the base branch from
dependabot/maven/io.springfox-springfox-swagger-ui-2.10.0
to
master
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Migrate from Springfox to SpringDoc OpenAPI for Java 11 compatibility
Summary
This PR migrates the banking application's API documentation from Springfox (v2.9.2) to SpringDoc OpenAPI (v1.7.0) as part of the Java 8 to Java 11 migration. Springfox has known compatibility issues with Java 11+, while SpringDoc OpenAPI provides modern OpenAPI v3 support with automatic documentation generation from Spring Web annotations.
Key Changes:
springfox-swagger2andspringfox-swagger-ui, addedspringdoc-openapi-ui(v1.7.0)ApplicationConfig.java- SpringDoc auto-generates documentation without explicit configuration@Api,@ApiOperation,@ApiResponse,@ApiResponses) fromAccountControllerandCustomerControllerThe Swagger UI is now accessible at the same location:
http://localhost:8989/bank-api/swagger-ui/index.htmlReview & Testing Checklist for Human
mvn clean installpasses and application starts without errors on port 8989Notes
@RestController,@RequestMapping, etc.)Link to Devin run: https://app.devin.ai/sessions/3e435ce2bb294951b0e2ba3c8e747860
Requested by: Jaime Mizrachi (@jaime-leo)