Skip to content

Source code for Ballerina WebSocket service to AsyncAPI generator cmd tool

Notifications You must be signed in to change notification settings

thushalya/asyncapi-tools

Repository files navigation

Ballerina-AsyncAPI

The AsyncAPI Specification is a specification, which creates a event driven architecture base contract for APIs detailing all of its resources and channels in both human and machine-readable format for easy development, discovery, and integration. The AsyncAPI tools currently provide the following capabilities.

  1. Export the AsyncAPI definition of a Ballerina service.

The asyncapi1 command in Ballerina is used for Ballerina to AsyncAPI code generations.

Building from the Source

Setting Up the Prerequisites

  1. OpenJDK 11 (Adopt OpenJDK or any other OpenJDK distribution)

    Info: You can also use Oracle JDK. Set the JAVA_HOME environment variable to the pathname of the directory into which you installed JDK.

  2. Export GitHub Personal access token with read package permissions as follows,

    export packageUser=<Username>
    export packagePAT=<Personal access token>
    

Building the Source

Execute the commands below to build from the source.

  1. To build the library:

     ./gradlew clean build
    
  2. To run the integration tests:

     ./gradlew clean test
    
  3. To build the module without the tests:

     ./gradlew clean build -x test
    
  4. To publish to maven local:

     ./gradlew clean build publishToMavenLocal
    

Contributing to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

You can also check for open issues that interest you. We look forward to receiving your contributions.

For more information, go to the contribution guidelines.

Code of Conduct

All contributors are encouraged to read the Ballerina Code of Conduct.

Useful Links

Releases

No releases published

Packages

No packages published