Pokémon API

Too Long; Didn't Read

• /api/pokemon returns an array of 10 Pokemon and optionally a next page token.
• /api/pokemon?page={token} returns an array of all of the Pokemon starting from a provided page.
• /api/pokemon/1 return a single Pokemon.
• /api/pokemon/search/:query searches by the Pokemon's name.

API Overview

This API provides access to a Pokémon dataset. It includes endpoints for searching Pokémon by name, retrieving Pokémon by ID, and paginated Pokémon lists. Additionally, it supports chaos parameters (delay, flakiness, chaos) to introduce artificial latency and errors.

Endpoints

GET /api/pokemon/search/:search

Description

Search for Pokémon whose names start with the given query string.

Query Parameters

Responses

• ✅ 200 OK:

  {
    "pokemon": [
      { "id": 1, "name": "Bulbasaur", "classification": "Seed Pokémon" }
    ],
    "nextPage": "MQ==" // (Base64-encoded next page number)
  }
  

• ❌ 404 Not Found:

  { "error": "Page out of bounds" }
  

• ❌ 500 Internal Server Error (if Chaos Mode™ fails a request):

  { "error": "Something went wrong." }
  

GET /api/pokemon/:id

Description

Retrieve details for a specific Pokémon by its unique id.

Path Parameter

Query Parameters

Responses

• ✅ 200 OK:

  {
    "id": 1,
    "name": "Bulbasaur",
    "classification": "Seed Pokémon",
    "type": ["Grass", "Poison"]
  }
  

• ❌ 404 Not Found:

  { "error": "Pokémon not found" }
  

• ❌ 500 Internal Server Error (if Chaos Mode™ fails a request):

  { "error": "Something went wrong." }
  

GET /api/pokemon

Description

Fetch a paginated list of Pokémon.

Query Parameters

Responses

• ✅ 200 OK:

  {
    "pokemon": [
      { "id": 1, "name": "Bulbasaur", "classification": "Seed Pokémon" },
      { "id": 2, "name": "Ivysaur", "classification": "Seed Pokémon" }
    ],
    "nextPage": "MQ=="
  }
  

• ❌ 400 Bad Request (if page encoding is invalid):

  { "error": "Invalid page encoding" }
  

• ❌ 500 Internal Server Error (if Chaos Mode™ fails a request):

  { "error": "Something went wrong." }
  

Chaos Mode™ (withChaos Middleware)

This middleware introduces random errors and delays based on query parameters:

Summary of Endpoints

This API is RESTful, supports pagination, and includes a Chaos Mode™ for testing failure scenarios.