alrico88 / fakeREST

OpenAPI compliant REST API to generate random fake data

fakeREST

This is an OpenAPI compliant REST API to obtain random fake data. It uses and follows faker.js methods and options (as of v8.0.2).

It uses TRPC and trpc-openapi to generate the endpoints and documentation, and Nitro as the base server.

The interactive documentation is available at /swagger.

The OpenAPI doc is available at /openapi.

Setup

Make sure to install the dependencies:

# npm
npm install

# yarn
yarn install

# pnpm
pnpm install

Development Server

Start the development server on http://localhost:3000

npm run dev

Production

Build the application for production:

npm run build

Locally preview production build:

npm run preview

Check out the deployment documentation for more information.