forked from loafle/openapi-generator-original
b6db4f73f1
* generate samples * try fix * add new sample for fixed case * also improve native library Other libraries don't need fixes. * add oneOf_twoPrimitives.yaml * generate samples * resolve comment
137 lines
3.3 KiB
Markdown
137 lines
3.3 KiB
Markdown
# openapi-java-client
|
|
|
|
oneOf two primitives
|
|
- API version: 1.0.0
|
|
|
|
oneOf with two entries of type string, see https://github.com/OpenAPITools/openapi-generator/issues/10450
|
|
|
|
|
|
*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`
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation](#installation) instruction and execute the following Java code:
|
|
|
|
```java
|
|
|
|
// Import classes:
|
|
import org.openapitools.client.ApiClient;
|
|
import org.openapitools.client.ApiException;
|
|
import org.openapitools.client.Configuration;
|
|
import org.openapitools.client.models.*;
|
|
import org.openapitools.client.api.DefaultApi;
|
|
|
|
public class Example {
|
|
public static void main(String[] args) {
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
defaultClient.setBasePath("http://localhost");
|
|
|
|
DefaultApi apiInstance = new DefaultApi(defaultClient);
|
|
MyExamplePostRequest myExamplePostRequest = new MyExamplePostRequest(); // MyExamplePostRequest |
|
|
try {
|
|
apiInstance.myExamplePost(myExamplePostRequest);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling DefaultApi#myExamplePost");
|
|
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://localhost*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*DefaultApi* | [**myExamplePost**](docs/DefaultApi.md#myExamplePost) | **POST** /myExample |
|
|
|
|
|
|
## Documentation for Models
|
|
|
|
- [MyExamplePostRequest](docs/MyExamplePostRequest.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
|
|
|
|
|
|
|