Giter VIP home page Giter VIP logo

Comments (3)

thim81 avatar thim81 commented on May 19, 2024 1

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.

boyney123 avatar boyney123 commented on May 19, 2024

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.

boyney123 avatar boyney123 commented on May 19, 2024

AsyncAPI is now support as a plugin for eventcatalog, going to close this one for now 👍

from eventcatalog.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.