Conversation
…ntation was added to the pom
Fix/swagger support
|
There was a problem hiding this comment.
Pull request overview
This PR adds Swagger/OpenAPI documentation support to the OLSHEETS application by introducing the springdoc-openapi-starter-webmvc-ui dependency. This will enable interactive API documentation through Swagger UI, making it easier for developers to explore and test the API endpoints.
- Added springdoc-openapi-starter-webmvc-ui version 2.3.0 as a dependency
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <dependency> | ||
| <groupId>org.springdoc</groupId> | ||
| <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> | ||
| <version>2.3.0</version> | ||
| </dependency> | ||
|
|
There was a problem hiding this comment.
The springdoc-openapi-starter-webmvc-ui dependency is being added without any accompanying configuration or security updates. While the dependency itself is correct, this PR should include updates to SecurityConfig.java to permit access to Swagger UI endpoints (such as /v3/api-docs/, /swagger-ui/, and /swagger-ui.html), and potentially add configuration in application.properties for customizing the OpenAPI documentation. Without these changes, the Swagger UI will not be accessible to users due to the existing JWT authentication requirements.
| <dependency> | |
| <groupId>org.springdoc</groupId> | |
| <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> | |
| <version>2.3.0</version> | |
| </dependency> |
| <dependency> | ||
| <groupId>org.springdoc</groupId> | ||
| <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> | ||
| <version>2.3.0</version> |
There was a problem hiding this comment.
The version number is hardcoded for the springdoc-openapi-starter-webmvc-ui dependency. Consider defining it as a property in the properties section (e.g., springdoc.version) for consistency with other dependency versions in the project. This makes it easier to manage and update the version across the project, similar to how jacoco.version is defined.
No description provided.