JSON Export Schemas

Complete documentation of JSON structures exported by each generator.

Quick Navigation

GUID Generator Schema

The GUID generator exports an array of string values representing unique identifiers.

JSON Schema
[
  "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "6ba7b811-9dad-11d1-80b4-00c04fd430c8"
]
Format Options: GUIDs can be exported with/without hyphens, with/without braces, and in upper/lowercase.
Schema Definition
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
    "description": "A UUID/GUID string with optional formatting"
  }
}

People Generator Schema

The people generator exports an array of person objects with contact information and addresses.

JSON Example
[
  {
    "name": "John Smith",
    "email": "john.smith@example.com",
    "phone": "(555) 123-4567",
    "address": "123 Main St, Anytown, CA 12345"
  },
  {
    "name": "Jane Doe",
    "email": "jane.doe@example.com",
    "phone": "(555) 987-6543",
    "address": "456 Oak Ave, Another City, NY 67890"
  }
]
Schema Definition
{
  "type": "array",
  "items": {
    "type": "object",
    "required": ["name"],
    "properties": {
      "name": {
        "type": "string",
        "description": "Full name of the person"
      },
      "email": {
        "type": "string",
        "format": "email",
        "description": "Email address (optional)"
      },
      "phone": {
        "type": "string",
        "description": "Phone number (optional)"
      },
      "address": {
        "type": "string",
        "description": "Complete postal address (optional)"
      }
    }
  }
}

Orders Generator Schema

The orders generator exports an array of order objects with customer information and order details.

JSON Example
[
  {
    "orderNumber": "ORD-2024-001",
    "customerName": "Alice Johnson",
    "customerEmail": "alice.johnson@example.com",
    "customerPhone": "(555) 234-5678",
    "customerAddress": "789 Pine St, Sample City, TX 54321",
    "total": "$156.99",
    "status": "Shipped",
    "items": [
      {
        "productName": "Wireless Headphones",
        "details": "Electronics • Qty: 1",
        "price": "$79.99"
      },
      {
        "productName": "Phone Case",
        "details": "Accessories • Qty: 2",
        "price": "$77.00"
      }
    ]
  }
]
Schema Definition
{
  "type": "array",
  "items": {
    "type": "object",
    "required": ["orderNumber", "customerName", "items"],
    "properties": {
      "orderNumber": {
        "type": "string",
        "description": "Unique order identifier"
      },
      "customerName": {
        "type": "string",
        "description": "Customer's full name"
      },
      "customerEmail": {
        "type": "string",
        "format": "email",
        "description": "Customer's email address"
      },
      "customerPhone": {
        "type": "string",
        "description": "Customer's phone number"
      },
      "customerAddress": {
        "type": "string",
        "description": "Customer's address"
      },
      "total": {
        "type": "string",
        "description": "Order total amount (formatted currency)"
      },
      "status": {
        "type": "string",
        "description": "Order status (e.g., Pending, Shipped, Delivered)"
      },
      "items": {
        "type": "array",
        "items": {
          "type": "object",
          "required": ["productName"],
          "properties": {
            "productName": {
              "type": "string",
              "description": "Name of the product"
            },
            "details": {
              "type": "string",
              "description": "Product category and quantity info"
            },
            "price": {
              "type": "string",
              "description": "Item total price (formatted currency)"
            }
          }
        }
      }
    }
  }
}

TypeScript Definitions

Type definitions for TypeScript developers integrating with the exported data.

types.ts
// GUID Generator Types
export type GuidArray = string[];

// People Generator Types
export interface Person {
  name: string;
  email?: string;
  phone?: string;
  address?: string;
}

export type PeopleArray = Person[];

// Orders Generator Types
export interface OrderItem {
  productName: string;
  details?: string;
  price?: string;
}

export interface Order {
  orderNumber: string;
  customerName: string;
  customerEmail?: string;
  customerPhone?: string;
  customerAddress?: string;
  total?: string;
  status?: string;
  items: OrderItem[];
}

export type OrdersArray = Order[];

// API Response Types
export interface GeneratorResponse<T> {
  success: boolean;
  data: T;
  count: number;
  timestamp: string;
}