* Drop separate version property Not required as all Jackson packages usually tether on a version bump. * Update Jackson to v2.17.1 * Sync Jackson version used by Spring Boot with project version * Sync jackson update to v2.17.1 with generator templates * Regenerate samples with updated versions * Adjust test to current exception msg behavior * Add dependency mgmt to ensure matching version for transitive dependencies * Update library descriptions with correct Jackson version number * Update library descriptions with correct GSON and JSONB versions * Update retrofit library description with correct version number * Update retrofit description to include Jackson as an option This should have been done as part of in #16853. * Update remaining libary version descriptions with correct versions * Generate updated doc
openapi-java-client
Example - oneOf data type
-
API version: 1.0.0
-
Generator version: 7.7.0-SNAPSHOT
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Automatically generated by the OpenAPI Generator
Requirements
Building the API client library requires:
- Java 1.8+
- Maven (3.8.3+)/Gradle (7.2+)
Installation
To install the API client library to your local Maven repository, simply execute:
mvn clean install
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deploy
Refer to the OSSRH Guide for more information.
Maven users
Add this dependency to your project's POM:
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>openapi-java-client</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>
Gradle users
Add this dependency to your project's build file:
repositories {
mavenCentral() // Needed if the 'openapi-java-client' jar has been published to maven central.
mavenLocal() // Needed if the 'openapi-java-client' jar has been published to the local maven repo.
}
dependencies {
implementation "org.openapitools:openapi-java-client:1.0.0"
}
Others
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/openapi-java-client-1.0.0.jar
target/lib/*.jar
Usage
To add a HTTP proxy for the API client, use ClientConfig
:
import org.glassfish.jersey.apache.connector.ApacheConnectorProvider;
import org.glassfish.jersey.client.ClientConfig;
import org.glassfish.jersey.client.ClientProperties;
import org.openapitools.client.*;
import org.openapitools.client.api.DefaultApi;
...
ApiClient defaultClient = Configuration.getDefaultApiClient();
ClientConfig clientConfig = defaultClient.getClientConfig();
clientConfig.connectorProvider(new ApacheConnectorProvider());
clientConfig.property(ClientProperties.PROXY_URI, "http://proxy_url_here");
clientConfig.property(ClientProperties.PROXY_USERNAME, "proxy_username");
clientConfig.property(ClientProperties.PROXY_PASSWORD, "proxy_password");
defaultClient.setClientConfig(clientConfig);
DefaultApi apiInstance = new DefaultApi(defaultClient);
Getting Started
Please follow the installation instruction and execute the following Java code:
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://api.example.xyz/v1");
DefaultApi apiInstance = new DefaultApi(defaultClient);
try {
Example result = apiInstance.callList();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#callList");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Documentation for API Endpoints
All URIs are relative to http://api.example.xyz/v1
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | callList | GET /example |
Documentation for Models
Documentation for Authorization
Endpoints do not require authorization.
Recommendation
It's recommended to create an instance of ApiClient
per thread in a multithreaded environment to avoid any potential issues.