GeneratorsJava

Java quickstart

Generate a Java SDK by following the instructions on this page.

This page assumes that you have:

1

Pass fern check

Run fern check to ensure that your API definition is valid. If there are any errors, fix them before proceeding.

If you’re using an OpenAPI Specification, check out all of our supported extensions.

2

Add the SDK generator

Run the following command to add the Java SDK generator to generators.yml:

$fern add fern-java-sdk --group java-sdk

java-sdk is the name of the generators.yml group that configures your Java SDK’s output location and other metadata. You can customize this group name to differentiate between multiple SDKs across different languages (e.g., ruby-sdk, etc) in your organization.

This command adds the following group to generators.yml:

generators.yml
1  java-sdk: # group name
2    generators:
3      - name: fernapi/fern-java-sdk
4        version: 3.11.0
5        output:
6          location: local-file-system
7          path: ../sdks/java
3

Generate the SDK

Run the following command to generate your SDK:

$fern generate --group java-sdk

If you have multiple APIs, use the --api flag to specify the API you want to generate:

$fern generate --group java-sdk --api your-api-name

This creates a sdks folder in your current directory. The resulting folder structure looks like this:

$fern/ # created by fern init
>sdks/ # created by fern generate --group java-sdk
>├─ java
>    ├─ YourOrganizationApiClient.java
>    ├─ core/
>    └─ resources/
>        └─ imdb/
>            ├─ errors/
>            └─ types/