* Revert "prepare 7.10.0 release (#20128)" This reverts commit 12dfe8fe74a1515d1e69e00df9abe4128aa44160. * update to 7.11.0-SNAPSHOT, update samples * update docs
petstore-okhttp-gson-31-do
OpenAPI Petstore
- API version: 1.0.0
- Generator version: 7.11.0-SNAPSHOT
This is a sample server Petstore server. For this sample, you can use the api key special-key
to test the authorization filters.
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>petstore-okhttp-gson-31-do</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 'petstore-okhttp-gson-31-do' jar has been published to maven central.
mavenLocal() // Needed if the 'petstore-okhttp-gson-31-do' jar has been published to the local maven repo.
}
dependencies {
implementation "org.openapitools:petstore-okhttp-gson-31-do:1.0.0"
}
Others
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/petstore-okhttp-gson-31-do-1.0.0.jar
target/lib/*.jar
Getting Started
Please follow the installation instruction and execute the following Java code:
// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FakeApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://petstore.swagger.io/v2");
FakeApi apiInstance = new FakeApi(defaultClient);
try {
Object result = apiInstance.getPetById0();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FakeApi#getPetById0");
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://petstore.swagger.io/v2
Class | Method | HTTP request | Description |
---|---|---|---|
FakeApi | getPetById0 | GET /fake/duplicated/operationId | |
PetApi | getPetById | GET /pet/{petId} | Find pet by ID |
Documentation for Models
Documentation for Authorization
Authentication schemes defined for the API:
petstore_auth
- Type: OAuth
- Flow: implicit
- Authorization URL: http://petstore.swagger.io/api/oauth/dialog
- Scopes:
- write:pets: modify pets in your account
- read:pets: read your pets
api_key
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
Recommendation
It's recommended to create an instance of ApiClient
per thread in a multithreaded environment to avoid any potential issues.