https://github.com/idsulik/fakerapi

FakerApi provides dynamic json rest api with dynamic fields/values. Uses https://github.com/joke2k/faker/tree/master
https://github.com/idsulik/fakerapi

dummy-api faker faker-api python

Last synced: 9 days ago
JSON representation

FakerApi provides dynamic json rest api with dynamic fields/values. Uses https://github.com/joke2k/faker/tree/master

• Host: GitHub
• URL: https://github.com/idsulik/fakerapi
• Owner: idsulik
• Created: 2023-07-26T18:23:12.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-27T16:42:26.000Z (over 1 year ago)
• Last Synced: 2024-10-08T13:07:03.164Z (about 1 month ago)
• Topics: dummy-api, faker, faker-api, python
• Language: Python
• Homepage: https://fakerapi-awurkxxgka-uc.a.run.app
• Size: 9.77 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# FastAPI Faker Server

This is a FastAPI based server that generates fake data using the Faker library. This server can be used to quickly generate mock data for testing or development purposes.

# Examples

- [/users?fields=name,address,email,first_name](https://fakerapi-awurkxxgka-uc.a.run.app/users?fields=name,address,email,first_name)

- [/posts?fields=uuid4,image_url,sentence,text,date&locale=ru_RU](https://fakerapi-awurkxxgka-uc.a.run.app/posts?fields=uuid4,image_url,sentence,text,date&locale=ru_RU)

- [/comments?fields=user_name,text,first_name](https://fakerapi-awurkxxgka-uc.a.run.app/comments?fields=user_name,text,first_name)

# Features

- Get a list of available fields that can be used to generate data.

- Generate data with custom fields and in different locales.

- Limit the number of data entries to be generated.

# Endpoints

- `/available_field`s: Returns a list of fields available for data generation.

- `/{any}`: Returns fake data entries. You can specify the locale, limit the number of entries, and optionally provide specific fields.

# Quick Start

1. Clone this repository.

2. Install the requirements: pip install -r requirements.txt

3. Run the server: python main.py

4. Visit http://localhost:8000/docs for the interactive API documentation.

# Contributing

Contributions are welcome! Please open an issue if you find a bug or wish to propose a feature. Pull requests are also appreciated.

# License

MIT