Faker Reference for Mockarty

Table of Contents

1. Overview
2. Address
3. DateTime
4. Internet
5. Text
6. Payment
7. Person
8. Phone
9. ID and Hashes
10. Business
11. Russian
12. Common Types
13. Math Functions
14. Go Template Syntax
15. Practical Examples

Overview

Faker in Mockarty generates random test data for dynamic mock responses. Every field listed below is a zero-argument accessor available through JPath as $.fake.FieldName.

{
  "response": {
    "payload": {
      "id": "$.fake.UUID",
      "name": "$.fake.FirstName",
      "email": "$.fake.Email",
      "createdAt": "$.fake.RFC3339"
    }
  }
}

Important: JPath mode does NOT support parameterized calls. $.fake.UUID is correct; $.fake.IntBetween(1, 100) will NOT work. Use Math Functions ($.increment, $.sum, $.multiply, $.subtract) for arithmetic.

Tip: Reusing generated values. Every $.fake.* call generates a new random value each time it is evaluated. If you need the same generated value in multiple places (e.g., the same UUID in both the response and an extraction), first extract it into a Mock Store (mStore), then reference it via $.mS.key:

{
  "extract": {
    "mStore": {
      "generatedId": "$.fake.UUID"
    }
  },
  "response": {
    "payload": {
      "id": "$.mS.generatedId",
      "link": "https://example.com/items/$.mS.generatedId"
    }
  }
}

This way generatedId is created once and reused consistently.

Address

{
  "response": {
    "payload": {
      "location": {
        "address": "$.fake.Address",
        "city": "$.fake.City",
        "state": "$.fake.State",
        "zip": "$.fake.ZipCode",
        "country": "$.fake.Country",
        "countryCode": "$.fake.CountryCode",
        "coordinates": {
          "lat": "$.fake.Latitude",
          "lng": "$.fake.Longitude"
        }
      }
    }
  }
}

DateTime

{
  "response": {
    "payload": {
      "createdAt": "$.fake.RFC3339",
      "date": "$.fake.Date",
      "time": "$.fake.TimeString",
      "unixTs": "$.fake.UnixTime",
      "month": "$.fake.MonthName",
      "year": "$.fake.YearString",
      "dayOfWeek": "$.fake.DayOfWeek",
      "dayOfMonth": "$.fake.DayOfMonth",
      "fullTimestamp": "$.fake.Timestamp",
      "timezone": "$.fake.Timezone",
      "period": "$.fake.TimePeriod"
    }
  }
}

Internet

{
  "response": {
    "payload": {
      "contact": {
        "email": "$.fake.Email",
        "website": "$.fake.URL"
      },
      "technical": {
        "ip": "$.fake.IPv4",
        "ipv6": "$.fake.IPv6",
        "mac": "$.fake.MacAddress",
        "userAgent": "$.fake.UserAgent",
        "domain": "$.fake.DomainName"
      },
      "style": {
        "color": "$.fake.Color",
        "hex": "$.fake.HexColor"
      }
    }
  }
}

Text

{
  "response": {
    "payload": {
      "title": "$.fake.Sentence",
      "description": "$.fake.Paragraph",
      "keyword": "$.fake.Word",
      "initial": "$.fake.Letter"
    }
  }
}

Payment

{
  "response": {
    "payload": {
      "payment": {
        "cardType": "$.fake.CCType",
        "cardNumber": "$.fake.CCNumber",
        "currency": "$.fake.Currency",
        "total": "$.fake.AmountWithCurrency",
        "price": "$.fake.Price"
      }
    }
  }
}

Person

{
  "response": {
    "payload": {
      "user": {
        "title": "$.fake.TitleMale",
        "firstName": "$.fake.FirstName",
        "lastName": "$.fake.LastName",
        "fullName": "$.fake.Name",
        "gender": "$.fake.Gender"
      }
    }
  }
}

Phone

{
  "response": {
    "payload": {
      "contact": {
        "phone": "$.fake.Phone",
        "tollFree": "$.fake.TollFreePhoneNumber",
        "international": "$.fake.E164PhoneNumber"
      }
    }
  }
}

ID and Hashes

{
  "response": {
    "payload": {
      "id": "$.fake.UUID",
      "shortId": "$.fake.UUIDDigit",
      "token": "$.fake.JWT",
      "checksum": "$.fake.MD5",
      "hash": "$.fake.SHA256"
    }
  }
}

Business

{
  "response": {
    "payload": {
      "employee": {
        "company": "$.fake.Company",
        "jobTitle": "$.fake.JobTitle"
      }
    }
  }
}

Russian

{
  "response": {
    "payload": {
      "russianUser": {
        "firstName": "$.fake.RussianFirstNameMale",
        "lastName": "$.fake.RussianLastNameMale"
      },
      "russianUserFemale": {
        "firstName": "$.fake.RussianFirstNameFemale",
        "lastName": "$.fake.RussianLastNameFemale"
      }
    }
  }
}

Common Types

{
  "response": {
    "payload": {
      "isActive": "$.fake.Bool",
      "label": "$.fake.String",
      "count": "$.fake.Number",
      "score": "$.fake.Int",
      "rate": "$.fake.Float",
      "code": "$.fake.Digit",
      "positiveId": "$.fake.PositiveInt",
      "offset": "$.fake.NegativeInt",
      "encoded": "$.fake.Base64",
      "ttl": "$.fake.Duration"
    }
  }
}

Math Functions

These are NOT part of $.fake.* but are standalone JPath math expressions. They accept JPath expressions or literal numbers as arguments.

Arguments can be:

• Literal numbers: 5, 3.14
• JPath expressions: $.gS.counter, $.cS.amount
• Expressions with fallback: $.gS.counter || 0 (use 0 if the store key is missing)

{
  "response": {
    "payload": {
      "nextId": "$.increment($.gS.lastId || 0)",
      "total": "$.sum($.gS.subtotal, $.gS.tax)",
      "extendedPrice": "$.multiply($.gS.quantity, $.gS.unitPrice)",
      "balance": "$.subtract($.gS.credit, $.gS.debit)"
    }
  }
}

Go Template Syntax

When using Go templates (.tmpl files or goTemplate: true), Faker is available via the fake function which returns a Faker object. Call zero-argument methods on it:

{
  "id": "{{(fake).UUID}}",
  "name": "{{(fake).FirstName}}",
  "email": "{{(fake).Email}}",
  "createdAt": "{{(fake).RFC3339}}"
}

The (fake) call returns a Faker struct, then .MethodName calls the corresponding method. For example:

{
  "user": {
    "id": "{{(fake).UUID}}",
    "firstName": "{{(fake).FirstName}}",
    "lastName": "{{(fake).LastName}}",
    "phone": "{{(fake).PhoneNumber}}",
    "isAdmin": {{(fake).Bool}},
    "createdAt": "{{(fake).RFC3339}}"
  }
}

Important: Not all JPath fields have Go Template methods. Only the methods listed in the table below are available in Go Template mode. JPath-only fields (like City, Company, MD5, Phone, Price, etc.) are populated on the JpathTemplateFakeData struct and are NOT callable via {{(fake).FieldName}}.

Available Go Template Methods

JPath-Only Fields (NOT Available in Go Template)

The following fields are available only via JPath $.fake.* and do NOT have corresponding Go Template methods:

City, Country, CountryCode, State, StreetAddress, ZipCode, Address, UserAgent, Color, HexColor, Letter, Digit, Gender, Phone, Number, Int, Float, Base64, Duration, Price, Company, JobTitle, MD5, SHA256

All listed fields are fully populated and return realistic values in JPath mode.

Go Template only: GetRealAddress() returns a real address object with fields Street, City, State, and Zip. This method is only available in Go Template mode via {{(fake).GetRealAddress}} – it is NOT accessible via JPath $.fake.GetRealAddress.

{
  "address": {
    "street": "{{(fake).GetRealAddress.Street}}",
    "city": "{{(fake).GetRealAddress.City}}",
    "state": "{{(fake).GetRealAddress.State}}",
    "zip": "{{(fake).GetRealAddress.Zip}}"
  }
}

Practical Examples

Complete User Profile

{
  "id": "user-profile",
  "http": {
    "route": "/api/users/profile"
  },
  "response": {
    "payload": {
      "user": {
        "id": "$.fake.UUID",
        "username": "$.fake.Username",
        "firstName": "$.fake.FirstName",
        "lastName": "$.fake.LastName",
        "fullName": "$.fake.Name",
        "gender": "$.fake.Gender",
        "email": "$.fake.Email",
        "phone": "$.fake.Phone",
        "address": {
          "street": "$.fake.StreetAddress",
          "city": "$.fake.City",
          "state": "$.fake.State",
          "zip": "$.fake.ZipCode",
          "country": "$.fake.Country",
          "lat": "$.fake.Latitude",
          "lng": "$.fake.Longitude"
        },
        "work": {
          "company": "$.fake.Company",
          "jobTitle": "$.fake.JobTitle"
        },
        "notifications": "$.fake.Bool",
        "createdAt": "$.fake.RFC3339",
        "ipAddress": "$.fake.IPv4",
        "userAgent": "$.fake.UserAgent"
      }
    }
  }
}

Financial Transaction

{
  "id": "financial-transaction",
  "http": {
    "route": "/api/transactions"
  },
  "response": {
    "payload": {
      "transaction": {
        "id": "$.fake.UUID",
        "type": "payment",
        "status": "completed",
        "amount": "$.fake.Price",
        "currency": "$.fake.Currency",
        "total": "$.fake.AmountWithCurrency",
        "card": {
          "type": "$.fake.CCType",
          "number": "$.fake.CCNumber"
        },
        "merchant": {
          "name": "$.fake.Company",
          "address": "$.fake.Address"
        },
        "customer": {
          "name": "$.fake.Name",
          "email": "$.fake.Email",
          "phone": "$.fake.Phone"
        },
        "hash": "$.fake.SHA256",
        "authCode": "$.fake.MD5",
        "processedAt": "$.fake.RFC3339"
      }
    }
  }
}

Complete Function List (Quick Reference)

All 74 available $.fake.* fields at a glance:

See Also

• JsonPath Guide – query language used together with Faker for dynamic responses
• Store Systems – persist Faker-generated data across mock invocations
• API Reference – complete REST API for creating mocks with Faker
• Web UI Guide – create mocks with Faker visually in the Constructor
• Quick Start – get started with your first Faker-powered mock