Comments (3)
AsyncAPi is a structured document, perfect for documentation and visualisation but it can also be used to generate clients.
While EventCatalog feels more like a "hub" to point towards the events & services documentation, generating an asyncAPI spec from the EventCatalog defined events would be interesting to kick-start the AsyncAPI writing.
But it would require plenty more manual additions and/or EventCatalog properties to make it a complete AsyncAPI like: channels, servers + you would end-up with a less-dry specification, since it would be difficult to generate a spec which uses $references.
The other way around would be my preferred workflow, define the AsyncAPI specification with re-usable schemas and generate "events" and JSON schemas out it.
But both can perfectly co-exists within EventCatalog, it is a matter of workflow.
from eventcatalog.
Yeah interesting, guess as you said there would be loads to consider (channels, etc), and it could complicate things pretty fast.
The other way around would be my preferred workflow, define the AsyncAPI specification with re-usable schemas and generate "events" and JSON schemas out it.
, yeah great let's start here for now with the plugin system and see how things go from there.
from eventcatalog.
AsyncAPI is now support as a plugin for eventcatalog, going to close this one for now 👍
from eventcatalog.
Related Issues (20)
- Cannot run build step - Attempted import error: 'useSyncExternalStore' is not exported from 'react' (imported as 'React2'). HOT 8
- Path contains invalid characters HOT 1
- Building a newly created project fails with "Can't resolve '../eventcatalog.styles.css'" HOT 1
- Clicking a non Event/Service graph node results in a runtime error
- Overriding next.js config is for largePageDataBytes
- Security vulnerability: Regular Expression Denial of Service in trim HOT 3
- Glossary for terms used in the business/org
- Event Search clears when enter pressed
- Enable adding new pages to the site HOT 2
- Owners are being removed from domains index.md file
- Data Lake 404's in the demo site
- content security policy need to have unsafe-eval to render the generated event page from AWS event bridge
- Search directly via the URL HOT 1
- [plugin-doc-generator-amazon-eventbridge] customized parts get deleted on generate HOT 3
- Undefined values when rendering SQS as targets in Amazon Event Bridge HOT 2
- yarn build on windows give a lot of ERR and not spitting out the static pages under /out folder
- EventCatalog v2 - What's new, thoughts and plan HOT 11
- Build error related to Mermaid in /events & /services in default demo HOT 4
- EventCatalog sponsorship? HOT 4
- Link "Click on Visualiser" doesn't work when services are Open API specifications
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from eventcatalog.