AutoBE
    Preparing search index...

    Interface IFormatRandom

    Format-based random data generator.

    Generates data matching specific standardized formats like emails, UUIDs, dates, and URLs. Critical for creating valid business data that conforms to standard formats and validation requirements in API operations.

    E2E testing importance: Ensures generated data passes format validation and represents realistic business data types, particularly essential for API operation parameters that require specific formats.

    interface IFormatRandom {
        format:
            | "date-time"
            | "byte"
            | "password"
            | "regex"
            | "uuid"
            | "email"
            | "hostname"
            | "idn-email"
            | "idn-hostname"
            | "iri"
            | "iri-reference"
            | "ipv4"
            | "ipv6"
            | "uri"
            | "uri-reference"
            | "uri-template"
            | "url"
            | "date"
            | "time"
            | "duration"
            | "json-pointer"
            | "relative-json-pointer"
            | "binary";
        type: "formatRandom";
    }
    Index

    Properties

    format type

    Properties

    format:
        | "date-time"
        | "byte"
        | "password"
        | "regex"
        | "uuid"
        | "email"
        | "hostname"
        | "idn-email"
        | "idn-hostname"
        | "iri"
        | "iri-reference"
        | "ipv4"
        | "ipv6"
        | "uri"
        | "uri-reference"
        | "uri-template"
        | "url"
        | "date"
        | "time"
        | "duration"
        | "json-pointer"
        | "relative-json-pointer"
        | "binary"

    Standardized format specification for data generation.

    Supports common business data formats essential for API operations:

    Security & Encoding:

    • "binary": Binary data representation
    • "byte": Base64 encoded data
    • "password": Password strings for authentication
    • "regex": Regular expression patterns

    Identifiers:

    • "uuid": Universally unique identifiers for entity references

    Network & Communication:

    • "email": Email addresses for user-related API operations
    • "hostname": Network hostnames for system integration
    • "idn-email": Internationalized email addresses
    • "idn-hostname": Internationalized hostnames
    • "ipv4": IPv4 addresses for network configuration
    • "ipv6": IPv6 addresses for network configuration

    Web & URI:

    • "uri": Uniform Resource Identifiers for API endpoints
    • "iri": Internationalized Resource Identifiers
    • "iri-reference": IRI references
    • "uri-reference": URI references
    • "uri-template": URI templates
    • "url": Web URLs for external resource references

    Date & Time:

    • "date-time": ISO 8601 date-time strings for API timestamps
    • "date": Date-only strings for business date fields
    • "time": Time-only strings for scheduling operations
    • "duration": Time duration strings for business processes

    JSON & Pointers:

    • "json-pointer": JSON Pointer strings for data navigation
    • "relative-json-pointer": Relative JSON Pointers

    AI format selection: Choose formats that match the business context and validation requirements of the target API operation field.

    type: "formatRandom"

    Type discriminator.

    Settings

    Member Visibility

    On This Page

    Properties