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
0
votes
2 answers

AsyncApi mark channel as deprecated

I am currently working on my API documentation with AsyncApi. I couldn't find an example of marking a channel as deprecated, does anyone know how to do that? I tried it as follow, but there is no visible sign that the channel is deprecated when…
philgsk
  • 51
  • 9
0
votes
1 answer

How can I host host generated HTML documentation (AsyncAPI) in Vercel?

I am generating an HTML file from a .yaml file using AsyncAPI for documentation within my project - I want to host this documentation on Vercel, but only that file within my project using a GitHub action so that every time a change is pushed or a PR…
sbuck89
  • 123
  • 3
  • 6
0
votes
1 answer

Modelina Csharp Generator Add Inheritance

I am playing around with asyncapi/modelina CSharpGenerator. I would like to add inheritance to the generated class something like this public class UserCreated: IEvent { } Is that possible? Can we add additional dependencies other…
Raajkumar
  • 857
  • 2
  • 13
  • 26
0
votes
1 answer

Confusion on AsyncAPI AMQP binding for subscribe operation

I have a server which publishes rabbitmq messages on a exchange, so I tried to create following async api specs for this - asyncapi: 2.3.0 info: title: Hello World version: 1.0.0 description: Get Hello World Messages contact: {} servers: …
shivMagus
  • 315
  • 4
  • 9
0
votes
1 answer

How can I generate client code for .NET applications using AsyncAPI specs?

The documentation for AsyncAPI says Generators are available for mainstream applications like Java, .NET, Javascript, etc. You can check out this repo for more information. However, there is no mention of .NET here. Am I missing something?
joshp
  • 706
  • 5
  • 22
0
votes
1 answer

How can I enable specification extensions in asyncapi-react-component?

I'm using the asyncapi react component to render asyncapi documents. (https://github.com/asyncapi/asyncapi-react) In the asyncapi specification it is allowed to use extensions (x-... values) at certain schema objects. (E.g. the server object:…
0
votes
1 answer

What is Correlation ID in AsyncAPI?

I'm trying to understand what correlation ids are in the AsyncAPI spec https://www.asyncapi.com/docs/specifications/v2.0.0#correlationIdObject There is a full example dedicated to this, but I still have no idea what's the purpose of this…
Balázs Édes
  • 13,452
  • 6
  • 54
  • 89
0
votes
1 answer

AsyncAPI and Json-LD Response

I am working on a project using JSON-LD as input and output format in Kafka. Now, I would like to define the messages with AsyncAPI for our documentation. But I am running into issue modeling attributes like @id or @type. The AsyncAPI provides an…
Stburcher
  • 64
  • 12
0
votes
1 answer

AsyncAPI: How many websockets will be used if both ends work as producer and consumer?

I have application constraints: Use AsyncAPI to document and specification of APIs Websockets for communications There will be only two systems, both will be producer and consumer (server and client) for each other I have a question that if both…
Techie Fort
  • 422
  • 7
  • 18
0
votes
0 answers

Cannot find npm module, after installing apisync-generator with npm

I've run into a wall with using AsyncAPI-Generator on a windows server. I've been following these instructions and after successfully installing ag I needed to update the path the be able to access the CLI. When running the cli I get an error saying…
Jontia
  • 137
  • 14
0
votes
2 answers

Is it okay to install `npm` as a dependency?

We want to use AsyncAPI to document our RabbitMQ messaging. Therefore, we installed asyncapi/generator as a npm dependency. If you have a look at the package.json you can see that it references npmi as a dependency which in turn is referencing to…
Theiaz
  • 568
  • 6
  • 24
0
votes
1 answer

How to publish AsyncApi in github-pages like swagger-github-pages?

I want to know how to publish (if possible) an AsyncApi project in github pages like We do with swagger-github-pages. My final goal is to have an AsyncApi documentation like the Swagger Petstore example available for the consumers
IgorAlves
  • 5,086
  • 10
  • 52
  • 83
0
votes
1 answer

Asyncapi allOf reusable schemas creates array instead of unified object in html rendering

I'm trying to write my first Asyncapi documentation file. I'd like to perform reusability of my schema between a reusableModel and others. However, the html documentation preview gives me an array with separate objects instead of one unified object.…
Oscar
  • 1,071
  • 13
  • 26
0
votes
2 answers

Can Kafka topic names be parameterised?

I've recently started experimenting with AsyncAPI as part of a project at work. My task is to see if we can use AsyncAPI to generate code to send test objects to our existing Kafka queues. I'm not familiar with Kafka. I'm starting with the API…
Ben R.
  • 1,965
  • 1
  • 13
  • 23
-1
votes
1 answer

AsyncApi Change npm registry url

Is there are command-line switch to point the npm registry to different url? I have created a template and published to our company's registry. When referring the package, it is referring to https://registry.npmjs.org/. I did install the template…
Raajkumar
  • 857
  • 2
  • 13
  • 26
1 2
3