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

User is able to focus only on business logic #59

Open
fmvilas opened this issue Mar 2, 2021 · 1 comment
Open

User is able to focus only on business logic #59

fmvilas opened this issue Mar 2, 2021 · 1 comment
Labels
Epic Outcome Product outcome (this is not a task) Pipeline: Now A key result we're working on right now or pretty soon.

Comments

@fmvilas
Copy link
Member

fmvilas commented Mar 2, 2021

Description

Ideally, the user should not be focusing on anything that's not related to their business logic. This includes learning the AsyncAPI specification. Nobody should be forced to learn the AsyncAPI spec to create a basic API. However, it doesn't mean the user should not be able to improve or create more complex APIs if they learn AsyncAPI and its tooling.

Scope

  1. An AsyncAPI file can be created without having to understand AsyncAPI syntax. This can be a CLI tool that asks questions, an application UI, a form, etc.
  2. Custom logic can be triggered when a message is received on a channel.
  3. Custom logic that sends a message can be triggered as the result of receiving a message, on startup, or any other application lifecycle event.
  4. Data models must be handled automatically, meaning the user doesn't have to manually create them.
  5. Sent and received messages must be validated against an AsyncAPI document.
  6. Works with the main protocols: HTTP, WebSockets, Kafka, AMQP 0-9-1, AMQP 1.0, MQTT, and MQTT5.
  7. Works with all the supported security schemes.
  8. The result is production-ready.
@fmvilas fmvilas added Outcome Product outcome (this is not a task) Epic Pipeline: Future A key result we might work on in the distant future. Pipeline: Now A key result we're working on right now or pretty soon. and removed Pipeline: Future A key result we might work on in the distant future. labels Mar 2, 2021
@boyney123
Copy link

Love the ideas here @fmvilas

The scope seems quite big, but I'm gonna spike some ideas around :

An AsyncAPI file can be created without having to understand AsyncAPI syntax. This can be a CLI tool that asks questions, an application UI, a form, etc.

Gonna see how it looks/feels creating the spec from a UI/Component, my thoughts are using some kind of UI to create events and servers etc etc link them up and generate the file....

Will ping some mockups/spikes here for community feedback before going deep on it :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic Outcome Product outcome (this is not a task) Pipeline: Now A key result we're working on right now or pretty soon.
Projects
None yet
Development

No branches or pull requests

2 participants