{
  "title": "Unit Conversion API Guide",
  "description": "This API allows you to convert between different units of measurement.",
  "endpoints": [
    {
      "path": "/convert",
      "method": "GET",
      "description": "Convert a value from one unit to another",
      "parameters": [
        {
          "name": "value",
          "type": "number",
          "required": true,
          "description": "The numerical value to convert"
        },
        {
          "name": "from",
          "type": "string",
          "required": true,
          "description": "The source unit"
        },
        {
          "name": "to",
          "type": "string",
          "required": true,
          "description": "The target unit"
        },
        {
          "name": "round",
          "type": "integer",
          "required": false,
          "description": "Number of decimal places to round to (non-negative)"
        }
      ],
      "examples": [
        {
          "description": "Convert 10 kilometers to miles",
          "request": "/convert?value=10&from=km&to=miles"
        },
        {
          "description": "Convert 100 Celsius to Fahrenheit with 1 decimal place",
          "request": "/convert?value=100&from=c&to=f&round=1"
        },
        {
          "description": "Convert 1.5 gigabytes to megabytes",
          "request": "/convert?value=1.5&from=GB&to=MB"
        }
      ],
      "responseFormat": {
        "success": {
          "originalValue": "number (the input value)",
          "fromUnit": "string (the source unit)",
          "convertedValue": "number (the converted result)",
          "toUnit": "string (the target unit)",
          "roundingPlaces": "number (only present if rounding was applied)"
        },
        "error": {
          "error": "string (error message explaining what went wrong)"
        }
      }
    },
    {
      "path": "/help",
      "method": "GET",
      "description": "Show this guide with information about the API"
    }
  ],
  "supportedCategories": {
    "Length": {
      "description": "Units for measuring distance or linear dimensions",
      "units": {
        "km": {
          "aliases": [
            "kilometer",
            "kilometers"
          ]
        },
        "miles": {
          "aliases": [
            "mi",
            "mile"
          ]
        },
        "m": {
          "aliases": [
            "meter",
            "meters"
          ]
        },
        "ft": {
          "aliases": [
            "foot",
            "feet"
          ]
        },
        "in": {
          "aliases": [
            "inch",
            "inches"
          ]
        },
        "cm": {
          "aliases": [
            "centimeter",
            "centimeters"
          ]
        }
      }
    },
    "Weight": {
      "description": "Units for measuring mass",
      "units": {
        "kg": {
          "aliases": [
            "kilogram",
            "kilograms"
          ]
        },
        "lbs": {
          "aliases": [
            "lb",
            "pound",
            "pounds"
          ]
        },
        "g": {
          "aliases": [
            "gram",
            "grams"
          ]
        },
        "oz": {
          "aliases": [
            "ounce",
            "ounces"
          ]
        }
      }
    },
    "Temperature": {
      "description": "Units for measuring temperature",
      "units": {
        "c": {
          "aliases": [
            "celsius"
          ]
        },
        "f": {
          "aliases": [
            "fahrenheit"
          ]
        },
        "k": {
          "aliases": [
            "kelvin"
          ]
        }
      }
    },
    "Computer Storage": {
      "description": "Units for measuring digital information storage (Base 1000)",
      "units": {
        "b": {
          "aliases": [
            "bit",
            "bits"
          ]
        },
        "B": {
          "aliases": [
            "byte",
            "bytes"
          ]
        },
        "KB": {
          "aliases": [
            "kilobyte",
            "kilobytes"
          ]
        },
        "MB": {
          "aliases": [
            "megabyte",
            "megabytes"
          ]
        },
        "GB": {
          "aliases": [
            "gigabyte",
            "gigabytes"
          ]
        },
        "TB": {
          "aliases": [
            "terabyte",
            "terabytes"
          ]
        },
        "PB": {
          "aliases": [
            "petabyte",
            "petabytes"
          ]
        }
      }
    },
    "Computer Network Speed": {
      "description": "Units for measuring data transfer rates (Base 1000)",
      "units": {
        "bps": {
          "aliases": [
            "bit/s",
            "bits/s"
          ]
        },
        "kbps": {
          "aliases": [
            "kbit/s",
            "kilobits/s"
          ]
        },
        "Mbps": {
          "aliases": [
            "Mbit/s",
            "megabits/s"
          ]
        },
        "Gbps": {
          "aliases": [
            "Gbit/s",
            "gigabits/s"
          ]
        },
        "Tbps": {
          "aliases": [
            "Tbit/s",
            "terabits/s"
          ]
        }
      }
    },
    "Time": {
      "description": "Units for measuring time durations",
      "units": {
        "ns": {
          "aliases": [
            "nanosecond",
            "nanoseconds"
          ]
        },
        "us": {
          "aliases": [
            "microsecond",
            "microseconds"
          ]
        },
        "ms": {
          "aliases": [
            "millisecond",
            "milliseconds"
          ]
        },
        "s": {
          "aliases": [
            "sec",
            "second",
            "seconds"
          ]
        },
        "min": {
          "aliases": [
            "minute",
            "minutes"
          ]
        },
        "h": {
          "aliases": [
            "hr",
            "hour",
            "hours"
          ]
        },
        "d": {
          "aliases": [
            "day",
            "days"
          ]
        },
        "wk": {
          "aliases": [
            "week",
            "weeks"
          ]
        }
      }
    },
    "Liquid Volume": {
      "description": "Units for measuring liquid capacity",
      "units": {
        "ml": {
          "aliases": [
            "mL",
            "milliliter",
            "milliliters"
          ]
        },
        "l": {
          "aliases": [
            "L",
            "liter",
            "liters"
          ]
        },
        "fl_oz": {
          "aliases": [
            "floz",
            "fluidounce",
            "fluidounces"
          ]
        },
        "cup": {
          "aliases": [
            "cups"
          ]
        },
        "pt": {
          "aliases": [
            "pint",
            "pints"
          ]
        },
        "qt": {
          "aliases": [
            "quart",
            "quarts"
          ]
        },
        "gal": {
          "aliases": [
            "gallon",
            "gallons"
          ]
        }
      }
    },
    "Area": {
      "description": "Units for measuring two-dimensional space",
      "units": {
        "sqm": {
          "aliases": [
            "m2",
            "squaremeter",
            "squaremeters"
          ]
        },
        "sqkm": {
          "aliases": [
            "km2",
            "squarekilometer",
            "squarekilometers"
          ]
        },
        "sqft": {
          "aliases": [
            "ft2",
            "squarefoot",
            "squarefeet"
          ]
        },
        "sqmi": {
          "aliases": [
            "mi2",
            "squaremile",
            "squaremiles"
          ]
        },
        "ha": {
          "aliases": [
            "hectare",
            "hectares"
          ]
        },
        "acre": {
          "aliases": [
            "acres"
          ]
        }
      }
    }
  }
}