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
.
Make sure to install the dependencies:
# npm
npm install
# yarn
yarn install
# pnpm
pnpm install
Start the development server on http://localhost:3000
npm run dev
Build the application for production:
npm run build
Locally preview production build:
npm run preview
Check out the deployment documentation for more information.