Awesome

Important Notes

This repository has been archived, and moved to the new repository here https://github.com/go-faker/faker Further development and fixing will be happening in the new repository.

Docs

faker

Struct Data Fake Generator

Faker will generate you a fake data based on your Struct.

Index

• Support
• Getting Started
• Example
• Limitation
• Contribution

Support

You can file an Issue. See documentation in Go.Dev

Getting Started

Download

go get -u github.com/bxcodec/faker/v4

Example

• Using Struct's tag:
  • basic tags: example_with_tags_test.go
  • length and bounds: example_with_tags_lenbounds_test.go
  • language: example_with_tags_lang_test.go
  • unique: example_with_tags_unique_test.go
  • slice length: example_with_tags_slicelength_test.go
• Custom Struct's tag (define your own faker data): example_custom_faker_test.go
• Without struct's tag: example_without_tag_test.go
• Single Fake Data Function: example_single_fake_data_test.go

DEMO

Benchmark

Bench To Generate Fake Data

Without Tag

BenchmarkFakerDataNOTTagged-4             500000              3049 ns/op             488 B/op         20 allocs/op

Using Tag

 BenchmarkFakerDataTagged-4                100000             17470 ns/op             380 B/op         26 allocs/op

MUST KNOW

The Struct Field must be PUBLIC.<br> Support Only For :

• int, int8, int16, int32 & int64
• []int, []int8, []int16, []int32 & []int64
• bool & []bool
• string & []string
• float32, float64, []float32 &[]float64
• time.Time & []time.Time
• Nested Struct Field

Limitation

Unfortunately this library has some limitation

• It does not support private fields. Make sure your structs fields you intend to generate fake data for are public, it would otherwise trigger a panic. You can however omit fields using a tag skip faker:"-" on your private fields.
• It does not support the interface{} data type. How could we generate anything without knowing its data type?
• It does not support the map[interface{}]interface{}, map[any_type]interface{} & map[interface{}]any_type data types. Once again, we cannot generate values for an unknown data type.
• Custom types are not fully supported. However some custom types are already supported: we are still investigating how to do this the correct way. For now, if you use faker, it's safer not to use any custom types in order to avoid panics.
• Some extra custom types can be supported IF AND ONLY IF extended with AddProvider() please see example
• The oneof tag currently only supports string, the int types, and both float32 & float64. Further support is coming soon (i.e. hex numbers, etc). See example for usage.

Contribution

To contrib to this project, you can open a PR or an issue.