Skip to content

docs(backend): add Springdoc Swagger UI OpenAPI documentation - #29

Merged
Sanan507 merged 2 commits into
Sanan507:masterfrom
raunakdeysarkar:feat/add-swagger-docs
Jul 26, 2026
Merged

docs(backend): add Springdoc Swagger UI OpenAPI documentation#29
Sanan507 merged 2 commits into
Sanan507:masterfrom
raunakdeysarkar:feat/add-swagger-docs

Conversation

@raunakdeysarkar

Copy link
Copy Markdown
Contributor

📌 Summary of Changes

Added springdoc-openapi-starter-webmvc-ui to generate interactive Swagger UI documentation for Spring Boot backend endpoints as requested in issue #19.


🛠️ Changes Made

  • backend/pom.xml: Added springdoc-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 @Tag and @Operation annotations for GET /api/catalog.
  • SimulationController.java: Added @Tag and @Operation annotations for sorting, searching, and pathfinding simulation endpoints.

🧪 Verification / How to Test

  1. Run the Spring Boot backend application.
  2. Navigate to http://localhost:8080/swagger-ui.html in a browser.
  3. Verified that all endpoints from CatalogController and SimulationController render accurately with schema details.

Closes #19

@vercel

vercel Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

@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.

@Sanan507
Sanan507 merged commit f5708d9 into Sanan507:master Jul 26, 2026
2 of 3 checks passed
@Sanan507

Copy link
Copy Markdown
Owner

Hi @raunakdeysarkar! 👋

Awesome work adding Springdoc Swagger UI annotations and configuration! Both CI build checks passed cleanly.

There was a minor merge conflict in backend/src/main/resources/application.yml due to a recently merged PR (#28). I have resolved the conflict and merged it into the master branch. Appreciate your contribution!

@raunakdeysarkar

Copy link
Copy Markdown
Contributor Author
Screenshot 2026-07-27 211052

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!

@Sanan507

Copy link
Copy Markdown
Owner

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! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(backend): Swagger / OpenAPI Documentation for Spring Boot Endpoints

2 participants