A flexible JSON server that can be integrated into Next.js
npm install @themodcraft/jserverbash
npm install npm i @themodcraft/jserver
`
Setup
$3
To start the JSON Server automatically when you run Next.js in development mode, you can wrap your next.config.js with withJServer.
`javascript
// next.config.js
import { withJServer } from '@themodcraft/jserver';
/* @type {import('next').NextConfig} /
const nextConfig = {
// Your Next.js config
};
export default withJServer(nextConfig);
`
This will start the JServer on the port specified in your JServer.json (defaulting to 3000, so make sure it doesn't conflict with Next.js which also defaults to 3000).
$3
You can also run it as a standalone service:
`bash
npx jserver
`
Or programmatically:
`javascript
import { startServer } from 'jserver';
startServer();
`
Features
- Dynamic Routing: Automatic resolution based on your db.json.
- Schema Validation: Uses AJV for JSON schema validation.
- OpenAPI/Swagger: Automatically generates documentation at /docs.
- Authentication: Built-in JWT support.
- Data Scrubber: Automatically removes sensitive information from responses.
Documentation
For detailed documentation on configuration options and features, please refer to the official documentation.
Funds
I don't need the funds, but if you want to support the project, you can do that by supporting the dependency of this projects:
$3
The following maintainers provide the core infrastructure for this project. Please consider sponsoring them:
| Maintainer / Project | Key Packages Supported | Funding Link |
| :--- | :--- | :--- |
| Evgeny Poberezkin | ajv | Sponsor |
| Fastify Team | fast-uri | Sponsor |
| Expressjs | express, body-parser, http-errors | Open Collective |
| Jordan Harband (ljharb) | qs, get-intrinsic, object-inspect | Sponsor |
| Paul Miller | chokidar, readdirp | Donate |
| DotenvX | dotenv | Website |
| Robert Kieffer (broofa) | uuid | Sponsor |
| sxzz (Sanix) | tsdown, ast-kit, rolldown-plugin-dts | Sponsor |
| Feross Aboukhadijeh | safe-buffer` | Sponsor |