Petstore API Reference
Version 1.0.0 — Generated API documentation for the Example Petstore.
Endpoints
GET/pets
Operation ID: listPets
Summary: List all pets
Parameters
| Name | Location | Type | Required |
|---|
| limit | query | integer | No |
Response (200)
A paged array of pets.
{
"type": "array",
"items": {
"id": "string",
"name": "string",
"tag": "string" (optional)
}
}
POST/pets
Operation ID: createPet
Summary: Create a new pet
Request Body (required)
{
"id": "string",
"name": "string",
"tag": "string" (optional)
}
Response (201)
The created pet object.
GET/pets/{petId}
Operation ID: getPetById
Summary: Get info for a specific pet
Parameters
| Name | Location | Type | Required |
|---|
| petId | path | string | Yes |
Response (200)
{
"id": "string",
"name": "string",
"tag": "string" (optional)
}
Pet Schema
| Field | Type | Required |
|---|
| id | string | Yes |
| name | string | Yes |
| tag | string | No |
Sample Data
Sample pet records conforming to the schema are available as a published JSON document containing 6 pets:
- Buddy (id: pet-001, tag: dog)
- Whiskers (id: pet-002, tag: cat)
- Thumper (id: pet-003, tag: rabbit)
- Goldie (id: pet-004, tag: fish)
- Polly (id: pet-005, tag: bird)
- Spike (id: pet-006, tag: dog)