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.0.2

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 false
boolean_digit 1
buildingNumber "5677"
card_expiration "09\/20"
card_number "6011968619444708"
card_type "Discover Card"
city "Lake Stephania"
company_name "Cole-Rolfson"
counter 1
country "Zimbabwe"
countryCode "HR"
date "1997-07-17"
dateTime {"date":"1993-01-07 09:28:05.000000","timezone_type":3,"timezone":"UTC"}
ean "8607741473395"
email "kulas.kathryn@smitham.org"
firstName "Percy"
image "http:\/\/placeimg.com\/640\/480\/any"
lastName "Bogisich"
latitude -2.915859
longText "Queen ordering off her unfortunate guests to execution--once more the shriek of the moment they saw her, they hurried back to my right size for going through the neighbouring pool--she could hear the Rabbit came up to her ear, and whispered 'She's under sentence of execution.' 'What for?' said Alice. 'You must be,' said the Rabbit's voice along--'Catch him, you by the Queen was to eat some of YOUR adventures.' 'I could tell you what year it is?' 'Of course not,' said the Footman, and began to repeat it, but her voice close to her, so she took courage, and went to school every day--' 'I'VE been to a day-school, too,' said Alice; 'I can't remember half of them--and it belongs to a mouse, That he met in the same thing, you know.' 'Not at first, perhaps,' said the King, going up to her great disappointment it was the first to speak. 'What size do you want to go! Let me see--how IS it to his ear. Alice considered a little, and then another confusion of voices--'Hold up his head--Brandy."
longitude -114.06212
name "Sophia Krajcik"
null null
number 512564084
phone "+1244643523492"
pokemon "Alomomola"
postcode "78287-1585"
state "Wyoming"
streetAddress "8250 Eladio Hill Apt. 895"
streetName "Nat Mall"
text "Adventures, till she was about a whiting to a mouse: she had brought herself down to nine inches high. CHAPTER VI. Pig and Pepper For a minute or two, which gave the Pigeon had finished. 'As if I."
upc "201827549737"
uuid "51b583b8-d706-3ab3-b46c-ff2608807802"
vat "52665839"
website "mann.com"
word "ut"

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: 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