Skip to main content

Java Design

The Java SDKs are designed to be easy to use and easy to debug. Various decisions were made that guide the design of the SDK, these include:

  • Using as little dependencies as possible, we use the Jackson Libary to (de)serialize our models, and use java.net HttpClients to make our HTTP requests.
  • Using annotations for all the models we generate, this allows us to append per field metadata to correctly serialize and deserialize models based on the OpenAPI document.
  • Including a utils module that contains methods for configuring the SDK and serializing/deserializing the types we generate, to avoid duplication of code in each method reducing the readability.

If you have any feedback or want to suggest improvements or ask for a new feature please get in contact in the #client-sdks channel in our public Slack.