-
Notifications
You must be signed in to change notification settings - Fork 3
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
Setup + reflection issues #12
Comments
Hey! Thank you for the feedback! ❤️ I will comment on each point, and I think we could start working on fixes/improvements.
https://github.com/Ferror/asyncapi-doc-bundle/blob/master/src/ClassFinder/ClassFinderInterface.php
|
@kiropowered, check out the latest version of the library. I managed to do some extra work around the documentation strategy and combined reflection and attributes. I also fixed the issue with empty servers. https://github.com/Ferror/asyncapi-doc-bundle/releases/tag/0.1.0-alpha.6 |
Hello,
Firstable I would like to thank you for the project.
It can potentially help me a lot by automatizing the generation of events schema and providing a clear documentation.
I actually use swagger as well to document my api so the idea of this package is straight forward and clear to implement.
So I tried your bundle following the setup guide, here is some feedbacks:
you mention asyncapi_version in config/packages/asyncapi_doc_bundle.yaml but it does not exist in the config, so I had to delete it
in the events config, you provide an exemple with a FQCN event, I tried to provide just a namespace but it does not seems to work therefore do we have to list all events in the config file ? Can it scans all the src(App namespace) folder for exemple ?
I created an event class with the Message attribute and constructor properties but without attributes.
it does not seems to use reflection by default to detect type and name leading to error like :
Property attribute for {variableName} not found when going to the live documentation
So I tried with the second exemple using Property attribute and it works.
Did I miss something to enable reflection ?
the config parameter servers seems required otherwise it leads to the error : undefined./servers should be object when going to the live documentation.(not mention in the setup)
the live documentation styles seems to be broken in dev mode
Maybe all these are just some misconfiguration I made
The text was updated successfully, but these errors were encountered: