Stack Overflow
Stack Overflow

Questions tagged [asyncapi]

AsyncAPI is an open source initiative that seeks to improve the current state of Event-Driven Architectures (EDA).

At its core, is the AsyncAPI specification intending to document message-driven APIs in a machine-readable way.

The specification sets the ground for various projects around that go a from parsers to code generators and mocking libraries.

Use this tag if you are posting an issue with one of the tools build atop the AsyncAPI spec.

45 questions
5
votes
2 answers

WSO2 API Manager Async APIs support

Is it possible in WSO2 API Manager, or maybe is it on the roadmap, to publish an async API, for example in Kafka, and manage it like other sync API with spec (Async API spec), security, analytics, etc? I am not referring to websocket APIs, that I…
Burillodev
  • 322
  • 1
  • 3
  • 14
4
votes
2 answers

How to document a mixture of synchronous and asynchronous APIs? Do we use AsyncAPI or OpenAPI or both?

Consider an application consisting of multiple end-points, some synchronous and others are asynchronous following the event-driven architecture with Kafka as the message broker, communicating with other microservices. What should be the standard for…
Viren
  • 91
  • 5
3
votes
1 answer

AsyncAPI definition among multiple yaml files

I am new using AsyncAPI specification. I have defined an AsyncAPI definition in a YAML file. As the definition is growing up I wanted to split it among several files. But I have no idea about how to do this. I have search some examples on Google,…
Manul
  • 31
  • 2
3
votes
3 answers

Difference Avro Vs Cloudevent Vs AsyncAPI | Best fit for Schema evolution and naming convention in kafka

I am using confluent schema registry. What is the difference between Avro Vs Cloudevent Vs AsyncAPI What is the best fit for Schema evolution and naming convention in kafka ? Can we use different schema types for different topics based on…
VinuBibin
  • 679
  • 8
  • 19
3
votes
2 answers

What is the AsyncAPI yaml equivalent representation of a Map in Avro schema

Trying to Map the data types supported in AsyncAPI to the ones available in Avro Schema. We have a Data type available in Avro schema that is Map , trying to find a way to represent it in Async API Yaml. Can anyone please advice ?
hemanth vinjarapu
  • 31
  • 1
2
votes
1 answer

How to share an `AsyncAPI` documentation with others?

Is there any way to share an AsyncAPI documentation with others? I used AsyncAPI Studio to write my API documentation. But I couldn't found a share option in AsyncAPI studio. Is there a way in AsyncAPI Studio/any other AsyncAPI editors that we can…
Udesh Athukorala
  • 383
  • 3
  • 10
2
votes
1 answer

AsyncAPI enum with specific values

Is it possible to create an enum with specific values in AsyncAPI? In my legacy c# code theres an enum like this public enum OrderStatus { Ordered = 30, UnderDelivery = 40, Deliveret = 50, Cancelled = 99 } I would like to create…
CruelIO
  • 18,196
  • 16
  • 40
  • 58
2
votes
0 answers

AsyncAPI specs: enum with description

I am starting in programming and I need to update an asyncapi.yaml file including an enum of different statuses, and I am also being asked to add descriptions to each of them. While updating this new features to the openapi.yaml used the following…
Martin Lupa
  • 31
  • 3
2
votes
1 answer

AsyncAPI Websockets Spring generated code and implementation

I want to generate code from AsyncAPI specification and try out how it works. My goal is to have only 1 socket open for each client and over that connection send/receive different types of messages. I couldnt find any example that would show me how…
nubi
  • 33
  • 1
  • 7
2
votes
1 answer

AsyncApi and RabbitMq

How do I put my RabbitMq exchange to an asyncapi definition? In the examples I found this ... channels: user/signup: publish: bindings: amqp: expiration: 100000 userId: guest cc: ['user.logs'] …
OkieOth
  • 3,604
  • 1
  • 19
  • 29
2
votes
1 answer

Compare two AsyncAPI specifications

Is there a tool that compares two AsyncAPI specifications and checks compatibility? I am thinking about an equivalent to OpenAPI-Diff or Swagger-Diff.
Vinz
  • 89
  • 1
  • 8
2
votes
1 answer

How do you show request-response semantics in AsyncAPI?

I am going through the specifications for Async API, but I can't find anything that would represent a request/response semantic for a channel. I am thinking from the context of Spring-Kafka with the @SendTo annotation that allows a response message…
Archimedes Trajano
  • 35,625
  • 19
  • 175
  • 265
1
vote
1 answer

How to create payload in AsyncApi?

My code works ok, but I need help with my documentation in nestjs-asyncapi and swagger. In my code, I have an object in the array, but in the documentation I have only an object. This is my nest js decorator: @AsyncApiSub({ channel:…
Martin54
  • 1,349
  • 2
  • 13
  • 34
1
vote
0 answers

socket.io and asyncapi integration

trying to build a socket.io server implementation using the socket.io java library and trying to figure out if there is any integration with AsyncAPI for the documentation, code generation etc.
Ramanth
  • 94
  • 2
  • 4
1
vote
1 answer

AsyncAPI: Only generate payload

Is it possible to skip generation of specific files using asyncapi-generator? I am using the Go generator but I only need the payload.go. Right now it always generates all files: handlers.go payloads.go publishers.go router.go server.go …
Jonathan R
  • 3,652
  • 3
  • 22
  • 40
1
2 3