https://github.com/ikatsuba/simulon
Simulon API is a HTTP server for generating fake data
https://github.com/ikatsuba/simulon
api-server backend data-generation data-mocking deno development-tools fake-data http-api lightweight-api mock-api mock-data prototyping random-data test-automation testing-tools
Last synced: 7 months ago
JSON representation
Simulon API is a HTTP server for generating fake data
- Host: GitHub
- URL: https://github.com/ikatsuba/simulon
- Owner: IKatsuba
- Created: 2024-12-20T19:03:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-12T13:26:43.000Z (12 months ago)
- Last Synced: 2025-07-04T08:01:41.101Z (7 months ago)
- Topics: api-server, backend, data-generation, data-mocking, deno, development-tools, fake-data, http-api, lightweight-api, mock-api, mock-data, prototyping, random-data, test-automation, testing-tools
- Language: TypeScript
- Homepage: https://simulon.katsuba.dev
- Size: 69.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simulon API
Simulon API is a HTTP server for generating fake data using the `faker` library.
It provides various endpoints to generate random data for different categories
such as airline, animal, book, color, commerce, company, database, date,
finance, food, git, hacker, image, internet, location, lorem, music, person,
phone, science, string, system, vehicle, and word.
## Installation
To set up the project locally, follow these steps:
1. Clone the repository:
```sh
git clone https://github.com/IKatsuba/simulon.git
cd simulon
```
2. Install the dependencies:
```sh
deno task dev
```
## Usage
To run the API locally, use the following command:
```sh
deno run --allow-net --allow-env --allow-read apps/api/main.ts
```
The API will be available at `http://localhost:8000`.
## Available API Endpoints
Here is a list of available API endpoints:
- `/v1/airline`
- `/v1/animal`
- `/v1/book`
- `/v1/color`
- `/v1/commerce`
- `/v1/company`
- `/v1/database`
- `/v1/datatype`
- `/v1/date`
- `/v1/finance`
- `/v1/food`
- `/v1/git`
- `/v1/hacker`
- `/v1/image`
- `/v1/internet`
- `/v1/location`
- `/v1/lorem`
- `/v1/music`
- `/v1/number`
- `/v1/person`
- `/v1/phone`
- `/v1/science`
- `/v1/string`
- `/v1/system`
- `/v1/vehicle`
- `/v1/word`
- `/v1/json`
For detailed information about each endpoint, refer to the OpenAPI documentation
available at `http://localhost:8000/openapi` and the Swagger UI at
`http://localhost:8000/ui`.