mirror of
https://github.com/ManyakRus/crud_generator.git
synced 2025-01-09 01:45:59 +02:00
105 lines
4.1 KiB
Markdown
105 lines
4.1 KiB
Markdown
|
# Docs
|
||
|
|
|
||
|
|
## [faker](#)
|
||
|
|
|
||
|
|
Struct Data Fake Generator
|
||
|
|
|
||
|
|
Faker will generate you a fake data based on your Struct.
|
||
|
|
|
||
|
|
[](https://travis-ci.org/bxcodec/faker)
|
||
|
|
[](https://codecov.io/gh/bxcodec/faker)
|
||
|
|
[](https://goreportcard.com/report/github.com/bxcodec/faker)
|
||
|
|
[](https://github.com/bxcodec/faker/blob/master/LICENSE)
|
||
|
|
[](https://godoc.org/github.com/bxcodec/faker)
|
||
|
|
[](https://pkg.go.dev/github.com/bxcodec/faker/v3?tab=doc)
|
||
|
|
|
||
|
|
## Index
|
||
|
|
|
||
|
|
* [Support](#support)
|
||
|
|
* [Getting Started](#getting-started)
|
||
|
|
* [Example](#example)
|
||
|
|
* [Limitation](#limitation)
|
||
|
|
* [Contribution](#contribution)
|
||
|
|
|
||
|
|
|
||
|
|
## Support
|
||
|
|
|
||
|
|
You can file an [Issue](https://github.com/bxcodec/faker/issues/new).
|
||
|
|
See documentation in [Godoc](https://godoc.org/github.com/bxcodec/faker) or in [Go.Dev](https://pkg.go.dev/github.com/bxcodec/faker/v3?tab=doc)
|
||
|
|
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
#### Download
|
||
|
|
|
||
|
|
```shell
|
||
|
|
go get -u github.com/bxcodec/faker/v3
|
||
|
|
```
|
||
|
|
# Example
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
- Using Struct's tag:
|
||
|
|
- [basic tags: example_with_tags_test.go](/example_with_tags_test.go)
|
||
|
|
- [length and bounds: example_with_tags_lenbounds_test.go](/example_with_tags_lenbounds_test.go)
|
||
|
|
- [language: example_with_tags_lang_test.go](/example_with_tags_lang_test.go)
|
||
|
|
- [unique: example_with_tags_unique_test.go](example_with_tags_unique_test.go)
|
||
|
|
- [slice length: example_with_tags_slicelength_test.go](example_with_tags_slicelength_test.go)
|
||
|
|
- Custom Struct's tag (define your own faker data): [example_custom_faker_test.go](/example_custom_faker_test.go)
|
||
|
|
- Without struct's tag: [example_without_tag_test.go](/example_without_tag_test.go)
|
||
|
|
- Single Fake Data Function: [example_single_fake_data_test.go](/example_single_fake_data_test.go)
|
||
|
|
|
||
|
|
## DEMO
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Benchmark
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
Bench To Generate Fake Data
|
||
|
|
#### Without Tag
|
||
|
|
```bash
|
||
|
|
BenchmarkFakerDataNOTTagged-4 500000 3049 ns/op 488 B/op 20 allocs/op
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Using Tag
|
||
|
|
```bash
|
||
|
|
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()](https://github.com/bxcodec/faker/blob/9169c33ae9926e5b8f8732909790ee20b10b736a/faker.go#L320) please see [example](example_custom_faker_test.go#L46)
|
||
|
|
* 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](example_with_tags_test.go#L53) for usage.
|
||
|
|
|
||
|
|
## Contribution
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
To contrib to this project, you can open a PR or an issue.
|