Impl OpenAPI UI - Githubissues

woile commented 2 hours ago

Issue submitter TODO list

[X] I've searched for an already existing issues here
[X] I'm running a supported version of the application which is listed here and the feature is not present there

Is your proposal related to a problem?

kafka-ui can be an excellent resource to communicate with kafka using HTTP. Which can facilitate integrations and other tooling.

Describe the feature you're interested in

In order to make kafka-ui as friendly as possible, specially for exploration of the api, It would be nice to expose an openapi UI under an endpoint, so developers can easily build integrations and easily debug in their context.

I propose adding the following endpoints if possible:

/docs

For UI there are many options:

swagger-ui (demo)
redoc (demo)
scalar (recommended) (demo). integration example

the idea would be to ship the statics with kafka-ui for one of these visualizers.

Regards

Describe alternatives you've considered

No response

Version you're running

b4ffd96

Additional context

No response

Haarolean commented 2 hours ago

We've used to expose the spec via swagger UI long time ago. I don't know why we got it removed, perhaps to lack of usage and additional burdens of maintenance. Feel free to raise a PR implementing a swagger UI. The spec is located here: https://github.com/kafbat/kafka-ui/blob/main/contract/src/main/resources/swagger/kafbat-ui-api.yaml

woile commented 1 hour ago

Gladly, if you had a link to the old commit I'd appreciate. I can probably implement the html, but I'm not familiar with java web dev

kafbat / kafka-ui

Impl OpenAPI UI #631