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.11.tar.gz (8.3 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.11-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: asyncapi-codegen-0.0.11.tar.gz
  • Upload date:
  • Size: 8.3 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.11.tar.gz
Algorithm Hash digest
SHA256 b9d61c27354b5334f0b0bebc2659ec2f6e75eebd6224ec69049fe19890e82727
MD5 08cd87f38195cf1363688c5ec87f1543
BLAKE2b-256 ec9d3135df38d6eefb7f4d21efa95a2f01e81e15d835e75f6fe076151bad5c4d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: asyncapi_codegen-0.0.11-py3-none-any.whl
  • Upload date:
  • Size: 32.4 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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 11d7883c735c6f28105f9f136fe9548fa8c544f93e332f722094fa65b24ee880
MD5 e599f8dec12cc23b75d7771d72ffca91
BLAKE2b-256 b8dc65b8730fb9ea95246aaf75d72822b1201c08492d596ab1e831ac863aecd8

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