Engine Swagger UI Integration and API Documentation

[evahteev]

Changes

• Added Swagger UI integration for API documentation
• Configured static OpenAPI specification serving
• Set up proper resource handling for API documentation

Technical Details

• Added OpenAPI specification in src/main/resources/static/openapi/openapi.json
• Created custom Swagger UI interface in src/main/resources/static/swagger-ui.html
• Configured Spring Boot to serve static content properly
• Added documentation for Camunda REST endpoints

Access Points

• Swagger UI: http://localhost:8080/swagger-ui.html
• OpenAPI Specification: http://localhost:8080/openapi/openapi.json

Testing

• Verify Swagger UI loads correctly
• Verify OpenAPI specification is accessible
• Test API documentation for Camunda endpoints
• Check if all endpoints are properly documented

Notes

• The project is already using Java 17, so no Java version update was needed
• Swagger UI is configured to use the latest version (5.9.0)
• OpenAPI specification includes both Spring Boot and Camunda endpoints

Dependencies

• Using unpkg.com CDN for Swagger UI resources
• No additional Maven dependencies required

Future Improvements

• Add more detailed API documentation
• Include request/response examples
• Add authentication documentation
• Consider adding API versioning