What's Faker API?

Faker API è un servizio API completamente gratuito che permette di generare dati fake in modo semplice e veloce, tutto tramite RESTful APIs. Non richiede nessuna iscrizione né l'utilizzo di token o altri sistemi di autenticazione.

Ogni risorsa permette la localizzazione in lingua tramite il parametro "_locale" e consente inoltre di scegliere la quantità di dati da generare tramite il parametro "_quantity", fino a un massimo di 1000 elementi.

Nel paragrafo Documentazione è possibile approfondire ogni risorsa. È inoltre disponibile la collection di Postman per poter utilizzare le nostre API tramite il noto client.

Al fondo di questa pagina, nella sezione Test, sarà invece possibile testare le nostre API tramite un apposito form.

Current version: 1.1.1

Docs

Non è richiesta nessuna chiave o token per l’utilizzo di Faker API. È un servizio gratuito e assolutamente open-source.

Postman:
Scarica la collection di Postman (versione 2.1)
Download Postman Collection

Base URL #

https://fakerapi.it/api/v1/{resource}

Basic Usage #

Alcune risorse permettono di filtrare i risultati in base ai parametri GET che vengono passati.
I nomi di questi parametri sono sempre preceduti da un underscore "_", ad esempio:

https://fakerapi.it/api/v1/images?_width=380

I dati sono sempre wrappati dentro a "data" e sono sempre accompagnati dal numero totale ("total") e dal codice Http della response.

Tutte le risorse accettano 3 parametri GET comuni:

_locale #

Default: en_US

Il parametro indica la localizzazione dei risultati che si vogliono ottenere e accetta il formato di tipo "it_IT". Esempio:

https://fakerapi.it/api/v1/persons?_locale=fr_FR

Questo esempio restituisce delle persone con nomi appartenenti alla lingua francese.

_quantity #

Default: 10

Max: 1000

Il parametro indica la quantità di risultati che si vogliono ottenere e accetta solo numeri interi. Se si richiedono più di 1000 risultati il sistema restituisce comunque 1000 risultati. Esempio:

https://fakerapi.it/api/v1/companies?_quantity=5

Questo esempio restituisce 5 aziende.

_seed #

Default: null

Il parametro accetta un numero intero e consente di ottenere più volte gli stessi risultati. Quindi eseguendo la stessa richiesta con il parametro _seed valorizzato con un numero (es. 12456) i risultati non cambieranno mai. Esempio:

https://fakerapi.it/api/v1/companies?_seed=12456

Resources #

Request:

https://fakerapi.it/api/v1/addresses?_quantity=1

Response:

Request:

https://fakerapi.it/api/v1/books?_quantity=1

Response:

Request:

https://fakerapi.it/api/v1/companies?_quantity=1

Response:

Request:

https://fakerapi.it/api/v1/credit_cards?_quantity=1

Response:

Additional optional parameters:

Parameter Description Example
_type any, animals, architecture, nature, people, tech, kittens, pokemon
_type=architecture
_width pixels (default: 640)
_width=500
_height pixels (default: 480)
_height=230

Request:

https://fakerapi.it/api/v1/images?_quantity=1&_type=kittens&_height=300

Response:

Additional optional parameters:

Parameter Description Example
_gender male, female
_gender=female
_birthday_start date in format Y-m-d (default: -90 years)
_birthday_start=1994-02-09
_birthday_end date in format Y-m-d (default: now)
_birthday_end=2018-10-09

Request:

https://fakerapi.it/api/v1/persons?_quantity=1&_gender=male&_birthday_start=2005-01-01

Response:

Request:

https://fakerapi.it/api/v1/places?_quantity=1

Response:

Additional optional parameters:

Parameter Description Example
_price_min number in format 10.35 (default: 0.01)
_price_min=20.50
_price_max number in format 10.35 (default: none)
_price_max=10320.99
_taxes percentage (default: 22)
_taxes=10
_categories_type integer, string, uuid (default: integer)
_categories_type=uuid

Request:

https://fakerapi.it/api/v1/products?_quantity=1&_taxes=12&_categories_type=uuid

Response:

Additional optional parameters:

Parameter Description Example
_characters integer (default: 200)
_characters=350

Request:

https://fakerapi.it/api/v1/texts?_quantity=1&_characters=500

Response:

Additional optional parameters:

Parameter Description Example
_gender male, female
_gender=female

Request:

https://fakerapi.it/api/v1/users?_quantity=1&_gender=male

Response:

Questa risorsa è l'unica che non segue le regole delle altre risorse.
I tre parametri comuni (_quantity, _locale, _seed) hanno lo stesso utilizzo delle altre risorse ma la request di questa risorsa deve essere gestita in modo diverso.

Le chiamate a questa risorsa accettano dei parametri custom secondo uno schema:

myCustomName1=customType1&myCustomName2=customType2

dove myCustomName1 e myCustomName2 sono i nomi che voglio dare ai parametri della mia risorsa custom, e customType1 e customType2 sono uno dei tipi di parametro accettati elencati qui sotto.

Essa consente di costruire una propria risorsa ad hoc usando i tipi di parametro qui elencati:

Parameter Example
boolean true
boolean_digit 1
buildingNumber "5866"
building_number "Vedi 'buildingNumber'"
card_expiration "11\/21"
card_number "2720041108282350"
card_type "Visa"
city "South Jimmyfurt"
company_name "Kshlerin-Pacocha"
counter 9
country "Saint Lucia"
countryCode "ST"
country_code "Vedi 'countryCode'"
date "2000-05-27"
dateTime {"date":"2004-01-22 03:38:18.000000","timezone_type":3,"timezone":"UTC"}
date_time "Vedi 'dateTime'"
ean "9939686226729"
email "shana.ondricka@robel.info"
firstName "Adell"
first_name "Vedi 'firstName'"
image "http:\/\/placeimg.com\/640\/480\/any"
lastName "Hudson"
last_name "Vedi 'lastName'"
latitude 89.900993
longText "It doesn't look like it?' he said, 'on and off, for days and days.' 'But what happens when one eats cake, but Alice had not attended to this last remark, 'it's a vegetable. It doesn't look like it?' he said, 'on and off, for days and days.' 'But what am I to get dry again: they had to be a queer thing, to be seen: she found herself in a sort of present!' thought Alice. 'I don't think they play at all anxious to have got in your knocking,' the Footman remarked, 'till tomorrow--' At this moment the door and found that, as nearly as she could not tell whether they were mine before. If I or she fell past it. 'Well!' thought Alice to herself, 'it would have made a dreadfully ugly child: but it all is! I'll try and say \"Who am I then? Tell me that first, and then, and holding it to the Classics master, though. He was an old conger-eel, that used to come before that!' 'Call the next question is, what?' The great question is, what did the Dormouse into the garden door. Poor Alice! It was the."
long_text "Vedi 'longText'"
longitude -55.877176
name "Talia Willms"
null null
number 775524
phone "+3466293607910"
pokemon "Exeggcute"
postcode "78642-9321"
state "Maryland"
streetAddress "92271 Sophia Circle Apt. 556"
streetName "Zetta Extension"
street_address "Vedi 'streetAddress'"
street_name "Vedi 'streetName'"
text "Alice looked all round her, about four feet high. 'I wish I could say if I can go back and finish your story!' Alice called out to her daughter 'Ah, my dear! I wish I could show you our cat Dinah: I."
upc "747496344490"
uuid "e59fbb20-73d7-3979-83a2-da16c4cdbf90"
vat "8525976010"
website "gerhold.com"
word "similique"

Custom request:

https://fakerapi.it/api/v1/custom?_quantity=1&customfield1=name&customfield2=dateTime&customfield3=phone

Response:

Test APIs

Test Response.

Changelogs

Date of release: 30 April 2021

  • Snake_case synonyms for some "custom" resources
  • General fixes

Date of release: 13 March 2021

  • Upgrading core technologies

Date of release: 23 April 2020

  • Added "pokemon" type to Custom resource
  • Added Pokémon images to Image resource

Date of release: 14 April 2020

  • Added "counter" type to Custom resource

Date of release: 12 April 2020

  • First release