API Documentation

Welcome to the MockDog API documentation. Here you can find details about available endpoints, parameters, and example responses.

GET /api/dogs

Returns a list of fake dog profiles. You can specify the number of profiles returned using the count query parameter.

Query Parameters:

count (optional, integer, 1-50): Number of dog profiles to return. Default is 10.

Example Request:

GET /api/dogs?count=5

Example Response:


{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "name": "Mochi",
      "age": 3,
      "gender": "female",
      "description": "A playful pup who loves chasing tennis balls and giving wet nose boops!",
      "imageUrl": "https://images.dog.ceo/breeds/hound-afghan/n02088094_1003.jpg"
    },
    // ...more dogs
  ],
  "count": 5,
  "total": 5
}

Available Endpoints

Simple REST API with all the endpoints you need

Method	Path	Description	Example
GET	/dogs	Get dog profiles (default: 10 dogs)	`https://mockdog.dev/api/dogs`
GET	/dogs?count=5	Get custom number of dog profiles (1-50)	`https://mockdog.dev/api/dogs?count=5`