Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Impl OpenAPI UI #631

Open
2 tasks done
woile opened this issue Oct 24, 2024 · 4 comments
Open
2 tasks done

Impl OpenAPI UI #631

woile opened this issue Oct 24, 2024 · 4 comments
Assignees
Labels
good first issue Up for grabs hacktoberfest Issues good for hacktoberfest goal scope/backend Related to backend changes status/triage/completed Automatic triage completed type/feature A brand new feature

Comments

@woile
Copy link

woile commented Oct 24, 2024

Issue submitter TODO list

  • I've searched for an already existing issues here
  • 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:

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

@woile woile added status/triage Issues pending maintainers triage type/feature A brand new feature labels Oct 24, 2024
@kapybro kapybro bot added status/triage/manual Manual triage in progress status/triage/completed Automatic triage completed and removed status/triage Issues pending maintainers triage labels Oct 24, 2024
@Haarolean
Copy link
Member

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

@Haarolean Haarolean added scope/backend Related to backend changes and removed status/triage/manual Manual triage in progress labels Oct 24, 2024
@Haarolean Haarolean moved this to Todo in Up for grabs Oct 24, 2024
@Haarolean Haarolean moved this to Revisit in Housekeeping Oct 24, 2024
@woile
Copy link
Author

woile commented Oct 24, 2024

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

@Haarolean Haarolean changed the title Expose openapi schema Impl OpenAPI UI Oct 24, 2024
@alkhimch
Copy link

Hi @Haarolean
Can I implement Swagger.ui configuration under the hacktoberfest tag ?

@Haarolean
Copy link
Member

Hi @Haarolean

Can I implement Swagger.ui configuration under the hacktoberfest tag ?

Hi, sure

@Haarolean Haarolean added good first issue Up for grabs hacktoberfest Issues good for hacktoberfest goal labels Oct 26, 2024
@Haarolean Haarolean moved this from Todo to In Development in Up for grabs Nov 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Up for grabs hacktoberfest Issues good for hacktoberfest goal scope/backend Related to backend changes status/triage/completed Automatic triage completed type/feature A brand new feature
Projects
Status: Revisit
Status: In Development
Development

No branches or pull requests

3 participants