openapi-generator/samples/client/petstore/java/okhttp-gson

swagger-petstore-okhttp-gson

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-petstore-okhttp-gson</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-petstore-okhttp-gson:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

• target/swagger-petstore-okhttp-gson-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PetApi;

import java.io.File;
import java.util.*;

public class PetApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: petstore_auth
        OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth");
        petstore_auth.setAccessToken("YOUR ACCESS TOKEN");
        
        

        PetApi apiInstance = new PetApi();
        
        Pet body = new Pet(); // Pet | Pet object that needs to be added to the store
        
        try {
            apiInstance.addPet(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling PetApi#addPet");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io/v2

Class	Method	HTTP request	Description
PetApi	addPet	POST /pet	Add a new pet to the store
PetApi	addPetUsingByteArray	POST /pet?testing_byte_array=true	Fake endpoint to test byte array in body parameter for adding a new pet to the store
PetApi	deletePet	DELETE /pet/{petId}	Deletes a pet
PetApi	findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
PetApi	findPetsByTags	GET /pet/findByTags	Finds Pets by tags
PetApi	getPetById	GET /pet/{petId}	Find pet by ID
PetApi	getPetByIdInObject	GET /pet/{petId}?response=inline_arbitrary_object	Fake endpoint to test inline arbitrary object return by 'Find pet by ID'
PetApi	petPetIdtestingByteArraytrueGet	GET /pet/{petId}?testing_byte_array=true	Fake endpoint to test byte array return by 'Find pet by ID'
PetApi	updatePet	PUT /pet	Update an existing pet
PetApi	updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
PetApi	uploadFile	POST /pet/{petId}/uploadImage	uploads an image
StoreApi	deleteOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
StoreApi	findOrdersByStatus	GET /store/findByStatus	Finds orders by status
StoreApi	getInventory	GET /store/inventory	Returns pet inventories by status
StoreApi	getInventoryInObject	GET /store/inventory?response=arbitrary_object	Fake endpoint to test arbitrary object return by 'Get inventory'
StoreApi	getOrderById	GET /store/order/{orderId}	Find purchase order by ID
StoreApi	placeOrder	POST /store/order	Place an order for a pet
UserApi	createUser	POST /user	Create user
UserApi	createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
UserApi	createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
UserApi	deleteUser	DELETE /user/{username}	Delete user
UserApi	getUserByName	GET /user/{username}	Get user by user name
UserApi	loginUser	GET /user/login	Logs user into the system
UserApi	logoutUser	GET /user/logout	Logs out current logged in user session
UserApi	updateUser	PUT /user/{username}	Updated user

Documentation for Models

• Animal
• Cat
• Category
• Dog
• InlineResponse200
• Model200Response
• ModelReturn
• Name
• Order
• Pet
• SpecialModelName
• Tag
• User

Documentation for Authorization

Authentication schemes defined for the API:

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorizatoin URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
  • write:pets: modify pets in your account
  • read:pets: read your pets

test_api_client_id

• Type: API key
• API key parameter name: x-test_api_client_id
• Location: HTTP header

test_api_client_secret

• Type: API key
• API key parameter name: x-test_api_client_secret
• Location: HTTP header

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header

test_http_basic

• Type: HTTP basic authentication

test_api_key_query

• Type: API key
• API key parameter name: test_api_key_query
• Location: URL query string

test_api_key_header

• Type: API key
• API key parameter name: test_api_key_header
• Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issue.

Author

apiteam@swagger.io