feat: migrate from Springfox to SpringDoc OpenAPI for Java 11 compatibility #68
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.
feat: migrate from Springfox to SpringDoc OpenAPI for Java 11 compatibility
Summary
Migrated API documentation from Springfox 2.9.2 to SpringDoc OpenAPI 1.6.15 to ensure compatibility with Java 11 and Spring Boot 2.1.4.
Changes:
springfox-swagger2andspringfox-swagger-uidependencies withspringdoc-openapi-ui(1.6.15)ApplicationConfig.javato use SpringDoc'sOpenAPIbean instead of SpringfoxDocket@Api,@ApiOperation,@ApiResponses)Why SpringDoc instead of Springfox 3.0.0?
Testing Performed:
mvn clean compile- BUILD SUCCESSmvn test- All tests pass (1/1)http://localhost:8989/bank-api/swagger-ui.htmlReview & Testing Checklist for Human
http://localhost:8989/bank-api/swagger-ui.htmland confirm all endpoints are visible (customer-controller: 5 endpoints, account-controller: 4 endpoints)/customers/all, POST/customers/add) to verify functionality is unchangedNotes
Devin Session: https://app.devin.ai/sessions/584c47c834034aa4a29be5e1c9db7d8b
Requested by: Jaime Mizrachi (@jaime-leo)
Known Tradeoffs:
Future Considerations:
@Operation,@ApiResponseannotations fromio.swagger.v3.oas.annotationspackage