Overview
Add the springdoc-openapi-starter-webmvc-ui dependency to pom.xml and document the API endpoints for interactive Swagger UI docs.
Implementation Details & File Reference
- Dependencies: Add
org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.5 to backend/pom.xml.
- Controllers: Add
@Operation, @ApiResponse, and @Schema annotations to SimulationController.java and CatalogController.java.
- Configuration: Configure Swagger UI path in
backend/src/main/resources/application.yml.
Definition of Done
- Visiting
/swagger-ui.html shows accurate, complete documentation for all simulation and catalog endpoints, including request/response schemas.
Skill Level
Good if comfortable with Spring Boot dependency config and basic OpenAPI annotations.
Overview
Add the springdoc-openapi-starter-webmvc-ui dependency to pom.xml and document the API endpoints for interactive Swagger UI docs.
Implementation Details & File Reference
org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.5tobackend/pom.xml.@Operation,@ApiResponse, and@Schemaannotations toSimulationController.javaandCatalogController.java.backend/src/main/resources/application.yml.Definition of Done
/swagger-ui.htmlshows accurate, complete documentation for all simulation and catalog endpoints, including request/response schemas.Skill Level
Good if comfortable with Spring Boot dependency config and basic OpenAPI annotations.