Package org.apache.juneau.petstore.client

Interface PetStoreClient

@Remote(path="/petstore")
public interface PetStoreClient

Typed client view of the petstore pet CRUD surface, consumed via org.apache.juneau.rest.client.RestClient#remote(Class).

Mirrors the pet endpoints of PetStoreResource (mounted at /petstore in both the Jetty and Spring Boot deployments). Demonstrates Juneau's REST client consuming a REST resource written with Juneau's REST server — the client interface and the server resource live in different modules but share nothing but the wire protocol and the Pet DTO.

See Also:

• REST Proxies
• juneau-petstore

Method Summary

Modifier and Type	Method	Description
Pet	addPet(Pet pet)	Creates a new pet.
Pet	getPet(long id)	Retrieves a pet by ID.
List<Pet>	getPets()	Lists all pets.

Method Details

getPets

@RemoteGet("/pets")
List<Pet> getPets()

Lists all pets.

Returns:

All pets.

getPet

@RemoteGet("/pets/{id}")
Pet getPet(@Path("id")
 long id)

Retrieves a pet by ID.

Parameters:

id - The pet ID.

Returns:

The pet.

addPet

@RemotePost("/pets")
Pet addPet(@Content
 Pet pet)

Creates a new pet.

Parameters:

pet - The pet to create.

Returns:

The created pet (with assigned ID).