Add Swagger Documentation to Project

[sohm22]

Add Swagger Documentation to Spring Boot Web Project

Objective

Integrate Swagger into the Spring Boot web project to provide API documentation for all available endpoints. This will help developers and users understand the API structure, input/output formats, and easily test the endpoints.

Tasks

1. Add Swagger dependencies (springdoc-openapi-ui) to the pom.xml file.
2. Configure Swagger in the application to scan the Controllers for API documentation.
3. Customize the Swagger UI, including the project title, description, and version.
4. Ensure all endpoints are documented with appropriate descriptions, parameters, and response types.
5. Add any necessary annotations in the code to improve documentation (e.g., @Operation, @ApiResponse, etc.).
6. Test the Swagger UI to verify all endpoints are correctly documented and accessible.

Acceptance Criteria

• Swagger UI should be accessible via a specific URL (e.g., /swagger-ui.html).
• All existing API endpoints should be visible in the Swagger UI with accurate request and response details.
• The Swagger documentation should reflect the current state of the API and update automatically with changes.

Additional Notes

• Consider using annotations like @Tag and @Parameter to improve the readability and organization of the API documentation.
• Ensure security configurations are appropriately set up for the Swagger UI if the API is protected.

[sohm22]

can be hosted at swaggerHUb