13 KiB

Raw Blame History

PetApi

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

Method	HTTP request	Description
addPet	POST /pet	Add a new pet to the store
deletePet	DELETE /pet/{petId}	Deletes a pet
findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
findPetsByTags	GET /pet/findByTags	Finds Pets by tags
getPetById	GET /pet/{petId}	Find pet by ID
updatePet	PUT /pet	Update an existing pet
updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
uploadFile	POST /pet/{petId}/uploadImage	uploads an image

addPet

addPet(body)

Add a new pet to the store

Example

// Import classes:
//import com.baeldung.petstore.client.invoker.ApiClient;
//import com.baeldung.petstore.client.invoker.ApiException;
//import com.baeldung.petstore.client.invoker.Configuration;
//import com.baeldung.petstore.client.invoker.auth.*;
//import com.baeldung.petstore.client.api.PetApi;

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();
}

Parameters

Name	Type	Description	Notes
body	Pet	Pet object that needs to be added to the store

Return type

null (empty response body)

Authorization

petstore_auth

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/xml, application/json

deletePet

deletePet(petId, apiKey)

Deletes a pet

Example

// Import classes:
//import com.baeldung.petstore.client.invoker.ApiClient;
//import com.baeldung.petstore.client.invoker.ApiException;
//import com.baeldung.petstore.client.invoker.Configuration;
//import com.baeldung.petstore.client.invoker.auth.*;
//import com.baeldung.petstore.client.api.PetApi;

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();
Long petId = 789L; // Long | Pet id to delete
String apiKey = "apiKey_example"; // String | 
try {
    apiInstance.deletePet(petId, apiKey);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#deletePet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
petId	Long	Pet id to delete
apiKey	String		[optional]

Return type

null (empty response body)

Authorization

petstore_auth

HTTP request headers

Content-Type: Not defined
Accept: application/xml, application/json

findPetsByStatus

List<Pet> findPetsByStatus(status)

Finds Pets by status

Multiple status values can be provided with comma separated strings

Example

// Import classes:
//import com.baeldung.petstore.client.invoker.ApiClient;
//import com.baeldung.petstore.client.invoker.ApiException;
//import com.baeldung.petstore.client.invoker.Configuration;
//import com.baeldung.petstore.client.invoker.auth.*;
//import com.baeldung.petstore.client.api.PetApi;

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();
List<String> status = Arrays.asList("status_example"); // List<String> | Status values that need to be considered for filter
try {
    List<Pet> result = apiInstance.findPetsByStatus(status);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#findPetsByStatus");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
status	List<String>	Status values that need to be considered for filter	[enum: available, pending, sold]

Return type

List<Pet>

Authorization

petstore_auth

HTTP request headers

Content-Type: Not defined
Accept: application/xml, application/json

findPetsByTags

List<Pet> findPetsByTags(tags)

Finds Pets by tags

Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Example

// Import classes:
//import com.baeldung.petstore.client.invoker.ApiClient;
//import com.baeldung.petstore.client.invoker.ApiException;
//import com.baeldung.petstore.client.invoker.Configuration;
//import com.baeldung.petstore.client.invoker.auth.*;
//import com.baeldung.petstore.client.api.PetApi;

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();
List<String> tags = Arrays.asList("tags_example"); // List<String> | Tags to filter by
try {
    List<Pet> result = apiInstance.findPetsByTags(tags);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#findPetsByTags");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
tags	List<String>	Tags to filter by

Return type

List<Pet>

Authorization

petstore_auth

HTTP request headers

Content-Type: Not defined
Accept: application/xml, application/json

getPetById

Pet getPetById(petId)

Find pet by ID

Returns a single pet

Example

// Import classes:
//import com.baeldung.petstore.client.invoker.ApiClient;
//import com.baeldung.petstore.client.invoker.ApiException;
//import com.baeldung.petstore.client.invoker.Configuration;
//import com.baeldung.petstore.client.invoker.auth.*;
//import com.baeldung.petstore.client.api.PetApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

PetApi apiInstance = new PetApi();
Long petId = 789L; // Long | ID of pet to return
try {
    Pet result = apiInstance.getPetById(petId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#getPetById");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
petId	Long	ID of pet to return

Return type

Pet

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/xml, application/json

updatePet

updatePet(body)

Update an existing pet

Example

// Import classes:
//import com.baeldung.petstore.client.invoker.ApiClient;
//import com.baeldung.petstore.client.invoker.ApiException;
//import com.baeldung.petstore.client.invoker.Configuration;
//import com.baeldung.petstore.client.invoker.auth.*;
//import com.baeldung.petstore.client.api.PetApi;

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.updatePet(body);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#updatePet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	Pet	Pet object that needs to be added to the store

Return type

null (empty response body)

Authorization

petstore_auth

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/xml, application/json

updatePetWithForm

updatePetWithForm(petId, name, status)

Updates a pet in the store with form data

Example

// Import classes:
//import com.baeldung.petstore.client.invoker.ApiClient;
//import com.baeldung.petstore.client.invoker.ApiException;
//import com.baeldung.petstore.client.invoker.Configuration;
//import com.baeldung.petstore.client.invoker.auth.*;
//import com.baeldung.petstore.client.api.PetApi;

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();
Long petId = 789L; // Long | ID of pet that needs to be updated
String name = "name_example"; // String | Updated name of the pet
String status = "status_example"; // String | Updated status of the pet
try {
    apiInstance.updatePetWithForm(petId, name, status);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#updatePetWithForm");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
petId	Long	ID of pet that needs to be updated
name	String	Updated name of the pet	[optional]
status	String	Updated status of the pet	[optional]

Return type

null (empty response body)

Authorization

petstore_auth

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/xml, application/json

uploadFile

ModelApiResponse uploadFile(petId, additionalMetadata, file)

uploads an image

Example

// Import classes:
//import com.baeldung.petstore.client.invoker.ApiClient;
//import com.baeldung.petstore.client.invoker.ApiException;
//import com.baeldung.petstore.client.invoker.Configuration;
//import com.baeldung.petstore.client.invoker.auth.*;
//import com.baeldung.petstore.client.api.PetApi;

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();
Long petId = 789L; // Long | ID of pet to update
String additionalMetadata = "additionalMetadata_example"; // String | Additional data to pass to server
File file = new File("/path/to/file.txt"); // File | file to upload
try {
    ModelApiResponse result = apiInstance.uploadFile(petId, additionalMetadata, file);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PetApi#uploadFile");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
petId	Long	ID of pet to update
additionalMetadata	String	Additional data to pass to server	[optional]
file	File	file to upload	[optional]

Return type

ModelApiResponse

Authorization

petstore_auth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

13 KiB Raw Blame History

PetApi

addPet

Example

Parameters

Return type

Authorization

HTTP request headers

deletePet

Example

Parameters

Return type

Authorization

HTTP request headers

findPetsByStatus

Example

Parameters

Return type

Authorization

HTTP request headers

findPetsByTags

Example

Parameters

Return type

Authorization

HTTP request headers

getPetById

Example

Parameters

Return type

Authorization

HTTP request headers

updatePet

Example

Parameters

Return type

Authorization

HTTP request headers

updatePetWithForm

Example

Parameters

Return type

Authorization

HTTP request headers

uploadFile

Example

Parameters

Return type

Authorization

HTTP request headers

13 KiB

Raw Blame History