Repository files navigation

Ballerina OpenAPI tools provide seamless integration between Ballerina and OpenAPI specifications, enabling bothcontract-first and code-first API development approaches. Thebal openapi command offers contract optimizationthroughflatten andalign operations to make OpenAPI contracts Ballerina-compatible, bidirectional code generationto create Ballerina services and clients from OpenAPI contracts or export OpenAPI specifications from Ballerinaservices, and build-time integration via theadd command for automated client generation. Additionally,the OpenAPI module provides annotations like@openapi:ServiceInfo,@openapi:ResourceInfo, and@openapi:Exampleto enrich generated contracts with metadata, enable runtime introspection by exposing OpenAPI documentation, validateservice implementations against existing contracts at compile-time, and enhance API documentation with examples anddescriptions.

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

   Info: You can also useOracle 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>

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

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

You can also check foropen issues thatinterest you. We look forward to receiving your contributions.

For more information, go to thecontribution guidelines.

All contributors are encouraged to read theBallerina Code of Conduct.

• Discuss about code changes of the Ballerina project inballerina-dev@googlegroups.com.
• Chat live with us via ourDiscord server.
• Post all technical questions on Stack Overflow with the#ballerina tag.
• View theBallerina performance test results.