forked from loafle/openapi-generator-original
* Revert "prepare 7.10.0 release (#20128)" This reverts commit 12dfe8fe74a1515d1e69e00df9abe4128aa44160. * update to 7.11.0-SNAPSHOT, update samples * update docs
164 lines
4.1 KiB
Markdown
164 lines
4.1 KiB
Markdown
# openapi-java-client
|
|
|
|
Example - oneOf data type
|
|
|
|
- API version: 1.0.0
|
|
|
|
- Generator version: 7.11.0-SNAPSHOT
|
|
|
|
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
|
|
|
|
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
|
|
|
|
## Requirements
|
|
|
|
Building the API client library requires:
|
|
|
|
1. Java 1.8+
|
|
2. Maven (3.8.3+)/Gradle (7.2+)
|
|
|
|
## Installation
|
|
|
|
To install the API client library to your local Maven repository, simply execute:
|
|
|
|
```shell
|
|
mvn clean install
|
|
```
|
|
|
|
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
|
|
|
|
```shell
|
|
mvn clean deploy
|
|
```
|
|
|
|
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
|
|
|
|
### Maven users
|
|
|
|
Add this dependency to your project's POM:
|
|
|
|
```xml
|
|
<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:
|
|
|
|
```groovy
|
|
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:
|
|
|
|
```shell
|
|
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`:
|
|
```java
|
|
|
|
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](#installation) instruction and execute the following Java code:
|
|
|
|
```java
|
|
|
|
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**](docs/DefaultApi.md#callList) | **GET** /example |
|
|
|
|
|
|
## Documentation for Models
|
|
|
|
- [Example](docs/Example.md)
|
|
|
|
|
|
<a id="documentation-for-authorization"></a>
|
|
## 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.
|
|
|
|
## Author
|
|
|
|
|
|
|