docs(backend): add Springdoc Swagger UI OpenAPI documentation - #29
Conversation
|
@raunakdeysarkar is attempting to deploy a commit to the sanan507's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
Hi @raunakdeysarkar! 👋 Awesome work adding Springdoc Swagger UI annotations and configuration! Both CI build checks passed cleanly. There was a minor merge conflict in |
Hey @Sanan507, noticed the Vercel deployment check failed on this PR (2/3 checks). It looks like a CI/build config issue. Could you check the Vercel error logs when you get a chance? If there are any specific backend/Springdoc dependencies or configs needed on my end to get it passing, let me know and I'll update it! |
|
Hi @raunakdeysarkar! No worries at all—your code and build configs were totally fine! The notice from Vercel was just a standard security prompt asking for owner authorization before deploying preview environments for external fork PRs. Both the backend and frontend CI builds passed without any issues, and the PR has been merged. Thanks again for the awesome work on the Swagger UI integration! 🚀 |

📌 Summary of Changes
Added
springdoc-openapi-starter-webmvc-uito generate interactive Swagger UI documentation for Spring Boot backend endpoints as requested in issue #19.🛠️ Changes Made
backend/pom.xml: Addedspringdoc-openapi-starter-webmvc-ui(v2.8.5) dependency.backend/src/main/resources/application.yml: Configured Swagger UI path to/swagger-ui.html.CatalogController.java: Added@Tagand@Operationannotations forGET /api/catalog.SimulationController.java: Added@Tagand@Operationannotations for sorting, searching, and pathfinding simulation endpoints.🧪 Verification / How to Test
http://localhost:8080/swagger-ui.htmlin a browser.CatalogControllerandSimulationControllerrender accurately with schema details.Closes #19