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

Is there any library to validate the ascynapi documents and show the errors in documents ? #1021

Open
ajit2k21 opened this issue Oct 19, 2024 · 2 comments
Labels
waiting for feedback Waiting for user feedback/response

Comments

@ajit2k21
Copy link

Created asyncapi document and tested it with springwolf-ui sample application. But it gives errors with springwolf-ui but giving no error with official AscynAPI UI (https://studio.asyncapi.com/). Can you please check the ascynapi file asyncapi-sample.json whether I missed anything in this file or not.

@ajit2k21 ajit2k21 added the bug Something isn't working label Oct 19, 2024
Copy link

Welcome to Springwolf. Thanks a lot for reporting your first issue. Please check out our contributors guide and feel free to join us on discord.

@timonback
Copy link
Member

Hi @ajit2k21,
there is no library for it and I considered it also as a non-goal.

Note: springwolf-ui doesn't support the full AsyncAPI spec.
Source: https://www.springwolf.dev/docs/faq

You can use springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.json as a reference for the structure.
Additionally, you can edit that file while running the npm start dev server in springwolf-ui and verify that no typescript errors are outputted.


As a general question, what are you trying to achieve? Have you considered using the async api renderer, since you use a non Springwolf-generated asyncapi file?

The AsyncApi renderer supports the full spec. Example: https://github.com/timonback/springwolf-asyncapi-ui/blob/main/template/index.ejs using the AsyncAPI library https://github.com/asyncapi/asyncapi-react

@timonback timonback added waiting for feedback Waiting for user feedback/response and removed bug Something isn't working labels Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
waiting for feedback Waiting for user feedback/response
Projects
None yet
Development

No branches or pull requests

2 participants