Faker Reference для Mockarty

Содержание

1. Обзор
2. Адреса
3. Дата и время
4. Интернет
5. Текст
6. Платежи
7. Персональные данные
8. Телефоны
9. Идентификаторы и хеши
10. Бизнес
11. Русские данные
12. Общие типы
13. Математические функции
14. Синтаксис Go Template
15. Практические примеры

Обзор

Faker в Mockarty генерирует случайные тестовые данные для динамических ответов моков. Каждое поле, перечисленное ниже, доступно как $.fake.FieldName в JPath-выражениях (без аргументов).

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

Важно: JPath-режим НЕ поддерживает параметризованные вызовы. $.fake.UUID – правильно; $.fake.IntBetween(1, 100) – НЕ будет работать. Для арифметики используйте математические функции ($.increment, $.sum, $.multiply, $.subtract).

Совет: повторное использование сгенерированных значений. Каждый вызов $.fake.* генерирует новое случайное значение при каждом вычислении. Если вам нужно одно и то же сгенерированное значение в нескольких местах (например, один и тот же UUID в ответе и в извлечении), сначала сохраните его в Mock Store (mStore), а затем ссылайтесь на него через $.mS.key:

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

Таким образом generatedId создаётся один раз и используется повторно единообразно.

Адреса

{
  "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"
        }
      }
    }
  }
}

Дата и время

{
  "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"
    }
  }
}

Интернет

{
  "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"
      }
    }
  }
}

Текст

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

Платежи

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

Персональные данные

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

Телефоны

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

Идентификаторы и хеши

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

Бизнес

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

Русские данные

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

Общие типы

{
  "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"
    }
  }
}

Математические функции

Эти функции НЕ являются частью $.fake.*, а представляют собой самостоятельные JPath-выражения. Принимают JPath-выражения или числовые литералы в качестве аргументов.

Аргументы могут быть:

• Числовыми литералами: 5, 3.14
• JPath-выражениями: $.gS.counter, $.cS.amount
• Выражениями со значением по умолчанию: $.gS.counter || 0 (если ключа нет в хранилище, используется 0)

{
  "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

При использовании Go-шаблонов (.tmpl-файлы или goTemplate: true) Faker доступен через функцию fake, которая возвращает объект Faker. Вызывайте методы без аргументов:

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

Вызов (fake) возвращает структуру Faker, затем .MethodName вызывает соответствующий метод. Например:

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

Важно: не все JPath-поля имеют методы Go Template. Только методы, перечисленные в таблице ниже, доступны в режиме Go Template. JPath-only поля (такие как City, Company, MD5, Phone, Price и др.) заполняются в структуре JpathTemplateFakeData и НЕ могут быть вызваны через {{(fake).FieldName}}.

Доступные методы Go Template

JPath-only поля (НЕ доступны в Go Template)

Следующие поля доступны только через JPath $.fake.* и НЕ имеют соответствующих методов Go Template:

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

Все перечисленные поля полностью заполняются и возвращают реалистичные значения в режиме JPath.

Только Go Template: GetRealAddress() возвращает объект реального адреса с полями Street, City, State и Zip. Этот метод доступен только в режиме Go Template через {{(fake).GetRealAddress}} – он НЕ доступен через JPath $.fake.GetRealAddress.

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

Практические примеры

Полный профиль пользователя

{
  "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"
      }
    }
  }
}

Финансовая транзакция

{
  "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"
      }
    }
  }
}

Полный список функций (краткая справка)

Все 74 доступных поля $.fake.*:

Смотрите также

• Руководство по JsonPath – язык запросов, используемый вместе с Faker для динамических ответов
• Системы хранилищ (Store) – сохранение сгенерированных Faker данных между вызовами моков
• Справочник API – полный REST API для создания моков с Faker
• Руководство по веб-интерфейсу – создание моков с Faker визуально в Конструкторе
• Быстрый старт – начните работу с первым моком на Faker