Pet API Documentation

Welcome to the Pet API! Below you'll find the endpoints and usage details to interact with the API effectively.

Endpoints

• GET /v1/all: Retrieve a list of all species.
• GET /v1/:species: Get details of a specific species by common name.
• GET /v1/:species/breeds: Retrieve all breeds for a specific species.
• GET /v1/breeds/all: Retrieve a list of all breeds.
• GET /v1/breeds/:breed: Get details of a specific breed by its ID.
• GET /v1/breeds/search?q=term: Search for breeds by name or species.
• GET /v1/health: Check the API status.

Pagination

Most endpoints support pagination using the ?page and ?limit query parameters.

GET /v1/breeds/all?page=1&limit=10

Versioning

The API is versioned to ensure backward compatibility. Current version: v1.

Search Functionality

You can search breeds by name or species using the /v1/breeds/search endpoint with a query parameter:

GET /v1/breeds/search?q=rabbit

Health Check

Use the /v1/health endpoint to verify the API status:

GET /v1/health

Example Request

Example cURL request to retrieve all species:

curl -X GET /v1/all

Response Format

All responses are in JSON format. Example response for /v1/breeds/all:

{
    "page": 1,
    "limit": 10,
    "total": 100,
    "totalPages": 10,
    "data": [
        {
            "_id": "64c3be5e759ca2d824ef452a",
            "name": { "en": "American Rabbit", "es": "Conejo Americano" },
            "species": "Rabbit",
            "description": { "en": "A popular breed...", "es": "Una raza popular..." }
        }
    ]
}