Implement Swagger API Documentation with Spring Boot

[leonard1thecoder]

Objective:
Integrate Swagger into the Spring Boot application to provide clear and interactive API documentation for users.

Tasks:

• Add Swagger/OpenAPI dependencies to the project pom.xml or build.gradle.
• Configure Swagger for the project, ensuring it's accessible to users and documents all endpoints.
• Customize the Swagger UI (if required) for branding and usability.
• Document each endpoint with clear usage, parameters, and expected responses.
• Provide guidance for users on accessing and using the Swagger UI.
• Ensure sensitive endpoints (if any) are excluded or require proper authentication in the docs.
• Add screenshots or usage examples if appropriate.

Acceptance Criteria:

• Swagger documentation is accessible via a dedicated URL (e.g., /swagger-ui.html or /api-docs).
• All relevant endpoints are properly documented and tested.
• Instructions for usage are included in the README or documentation section.

Let me know if you require further customizations to the Swagger setup or if there are specific endpoints you want highlighted.