📘 Bluey API Documentation

Welcome to the Bluey API documentation! This RESTful API allows you to explore detailed information about characters from the beloved animated series Bluey.

📍 Base URL

🧩 Endpoints

curl https://api.blueyapi.dev/characters
curl https://api.blueyapi.dev/characters/1

🔹 GET /characters

Retrieve a list of all available characters.

✅ Response

{
  "response": {
    "data": [{
      "_id": 1,
      "name": "Bluey Heeler",
      "age": 6,
      "breed": "Blue Heeler",
      "sourceUrl": "https://example.com",
      "imageUrl": "https://example.com/image.jpg",
      "episode": ["Magic Xylophone"],
      "minisodes": [],
      "books": [],
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-05T00:00:00.000Z",
      "url": "https://api.blueyapi.dev/characters/1"
    }],
    "count": 1,
    "timestamp": "2025-03-31T15:13:29.407Z"
  },
  "error": null
}

🔹 GET /characters/:id

Retrieve a specific character by its ID.

🔸 Parameters

✅ Response

{
  "response": {
    "data": {
      "_id": 1,
      "name": "Bluey Heeler",
      "age": 6,
      "breed": "Blue Heeler",
      "sourceUrl": "https://example.com",
      "imageUrl": "https://example.com/image.jpg",
      "episode": ["Magic Xylophone"],
      "minisodes": [],
      "books": [],
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-05T00:00:00.000Z",
      "url": "https://api.blueyapi.dev/characters/1"
    },
    "timestamp": "2025-03-31T12:00:00.000Z"
  },
  "error": null
}

⚠️ Error Handling

Errors are formatted uniformly with the following structure:

{
  "response": null,
  "error": {
    "message": "Character not found",
    "stack": "...stack trace...",
    "status": 404
  }
}

All responses are wrapped using a global interceptor, ensuring consistent formatting for both success and error cases.

🧪 Tech Stack

• NestJS for backend and routing.
• class-transformer for serialization (DTO).
• Interceptor for global response formatting.
• Astro for frontend documentation and playground.

📦 Future Improvements

• Search and filter endpoints (/characters?name=Bluey)
• Pagination support
• Caching layer
• Related resources (episodes, locations, etc.)

👨‍💻 Author

Built with ❤️ by Norman Torres as a way to explore modern backend and frontend frameworks, and share something fun inspired by his son’s favorite show — Bluey.

🗃️ License

MIT