Golden OpenAPI Library

The Golden OpenAPI Library is a Java library designed to simplify integration with the Golden API in your projects. It provides pre-built Java objects that enable you to interact with the API seamlessly, without the need to manually handle OpenAPI specifications.

We provide an open-source project for the Golden OpenAPI Library

The source code is available in a public GitHub repository: https://github.com/trazadera-public/trazadera-golden-openapi .

Installation

The library is published as a standard Maven package and can be installed by following the packages instructions.

Remember to use the latest API version

To integrate the library into your project, update your pom.xml file to include the necessary dependency.

XML

<dependency>
  <groupId>com.trazadera</groupId>
  <artifactId>trazadera-golden-openapi</artifactId>
  <version>16-SNAPSHOT</version>
</dependency>

Using the Java Library

The library is generated using the Swagger Codegen tool with Java as the target platform. The bin/generate-openapi-cli.sh script contains the necessary commands to generate the Java client using the default configuration.

The code structure is straightforward. The package organization under com.trazadera.golden.restclient is as follows:

api: Contains the main API classes, with one class for each API category.

model: Contains the data transfer objects (DTOs) used to transfer data between the client and the API.

invoker: Contains the communication-related objects, with ApiClient being the primary class responsible for handling requests and responses.

To get started with the library, refer to the SampleClientUsage example provided.