List of AsyncAPI servers in MuleSoft

devalexmartinez

Alex Martinez

Posted on October 22, 2024

List of AsyncAPI servers in MuleSoft

After the October '24 release of Anypoint Code Builder, the AsyncAPI specification/implementation process in MuleSoft now supports the following message brokers:

  • AnypointMQ
  • Kafka
  • Solace
  • Salesforce Platform Events

As I was reading through the documentation, I wasn't able to find a list of the servers that you need to set up in your AsyncAPI specification in order for the APIKit to pick up the correct configuration.

I did find, however, an example specification with the four available brokers. Thanks to this, I was able to get the list of protocols you need to use in your specifications.

Here's the example from the docs (note that this applies to version 2.6 of AsyncAPI):

servers: 
  AMQ-prod:
    url: https:://your_MQ_server_URL_here
    protocol: anypointmq
    protocolVersion: v1
    description: Anypoint MQ broker
  kafka-prod:
    url: your_kafka_URL_here
    protocol: kafka
    description: kafka broker
  sfpubsub-prod:
      protocol: salesforcepubsub
      protocolVersion: v1
      url: api.pubsub.salesforce.com
      description: Salesforce pub sub for Platform events production
  solace-server:
    protocol: solace
    variables:
      port:
        enum:
        - '1000'
    bindings:
      solace:
        msgVpn: your_solace_vpn_here
        bindingVersion: 0.4.0
    protocolVersion: 1.0.0
    url: mySolaceURL
Enter fullscreen mode Exit fullscreen mode

As we can see from the previous code, not all of them are set up the same way. For example, Solace needs way more configurations than Kafka or AnypointMQ. It also looks like the Salesforce configuration is static since it's using a specific URL.

Anyway, hope this list helps someone else out there who is not sure how to set up a specific server for your AsyncAPI specification in MuleSoft.

💖 💪 🙅 🚩
devalexmartinez
Alex Martinez

Posted on October 22, 2024

Join Our Newsletter. No Spam, Only the good stuff.

Sign up to receive the latest update from our blog.

Related

List of AsyncAPI servers in MuleSoft
mulesoft List of AsyncAPI servers in MuleSoft

October 22, 2024