Skip to main content

AsyncAPI Codegen

This 3rd-party open source tool creates C++ interfaces according to AsyncAPI specifications. Currently, only MQTT is supported.

Python Generator

The Python3 generator interprets a AsyncAPI specification and uses jinja2 templates to create a number of C++ sources and headers.

The AsyncAPI must be format-decoded first, using a JSON or YAML parser. The resulting parsed structure is then passed to the generator.

The generator interprets the specification directly. For example, if the specification defines a publish operation, the generator creates code for publishing.

Output files

The generator creates the following types of output files:

  • client interface. This is the main interface for publishing or subscribing to messages.
  • servers. Represents a connection to a server. Currently, only unauthenticated MQTT connections are supported. A server object is provided to a client interface to establish the connection to the broker/server.
  • parameters. These are just schema objects.
  • messages. Currently, these are just schema objects. However, in the future these objects will also take protocol-specific message bindings.
  • schemas. These are structures that always enforce schema compliance and provide (de-)serialization methods to rapidjson Value objects (which can thus be used to create JSON strings).

Generated code files should be annotated for doxygen document generation, or at least that is the goal.

Installation

pip3 install asyncapi-codegen

Python requirements for running code generator

See also requirements.txt

  • python 3.7
  • jinja2
  • stringcase
  • json-schema-codegen
  • pyyaml

Python requirements for generated python code

  • python 3.7
  • parse
  • paho-mqtt

C++ requirements for generated code

  • boost (boost::optional and boost::variant among others)
  • rapidjson
  • C++11

License

GPLv2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asyncapi-codegen-0.0.14.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

asyncapi_codegen-0.0.14-py3-none-any.whl (33.5 kB view details)

Uploaded Python 3

File details

Details for the file asyncapi-codegen-0.0.14.tar.gz.

File metadata

  • Download URL: asyncapi-codegen-0.0.14.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.8.0 tqdm/4.36.1 CPython/3.7.0

File hashes

Hashes for asyncapi-codegen-0.0.14.tar.gz
Algorithm Hash digest
SHA256 50e7e314f0794cacc616a6f962592fa1f5197642ec0db5e4c30a8c00ccd8ce5b
MD5 3305c82e6d70d9c7e842004a1a15b816
BLAKE2b-256 bc012af3e9dbc27501a1b875ff459edb0ed415d3144c6a84d218e65ad143bd26

See more details on using hashes here.

File details

Details for the file asyncapi_codegen-0.0.14-py3-none-any.whl.

File metadata

  • Download URL: asyncapi_codegen-0.0.14-py3-none-any.whl
  • Upload date:
  • Size: 33.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.8.0 tqdm/4.36.1 CPython/3.7.0

File hashes

Hashes for asyncapi_codegen-0.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 ad662910b322e40ee00dbeac0eb88610d9a2876cc6038ce85247214e7070c422
MD5 6319e6274bbc8b904715f468386535ed
BLAKE2b-256 208a50d1130e76ff5862ec5060b864dab22633469831b08dc7093665b53c2f92

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page