cruise-control icon indicating copy to clipboard operation
cruise-control copied to clipboard

Add Vertx.io based API with Swagger UI

Open viktorsomogyi opened this issue 3 years ago • 1 comments

Motivation

Currently Cruise Control uses the classic servlet technology today. This works but provides a limited extension points and it is generally a very basic framework. Extending Cruise Control in this framework with things like Swagger which is almost a must have these days is cumbersome. Swagger standardizes API, provides documentation support and an easy to use API UI that makes the Cruise Control API much easier to use.

About this task

This task attempts to tackle the task of introducing an alternative and modern Vertex.io based API parallel to the existing servlet one and based on the existing codebase. The new API will be fully compatible with the currently existing one to ease migration. It is basically just the same API running on Vertx and has a Swagger UI and the existing API documented with Swagger annotations.

Testing

The main testing we carry out are unit tests for white box testing and integration level validation (black box) that compares the outputs of the APIs with various parameters to verify behavior and backward compatibility.

viktorsomogyi avatar Aug 23 '21 12:08 viktorsomogyi

@kismob is working on this task.

viktorsomogyi avatar Aug 23 '21 12:08 viktorsomogyi