Restifizer

Common errors

• Error: Cannot find module 'restifizer'

  cause The 'restifizer' package or one of its required data source modules (e.g., 'restifizer-mongoose-ds') is not installed in your project's `node_modules`.
  fix Run `npm install restifizer restifizer-mongoose-ds express mongoose` (or `restifizer-sequelize-ds sequelize` for SQL databases) in your project directory to install the necessary dependencies.

• TypeError: app.use() requires a middleware function but got a Object

  cause This error typically occurs if `restifizer.resources()` is not called, or if the result of `restifizer.resources(...)` is not correctly passed as an Express middleware, possibly due to a version mismatch with Express.js or incorrect invocation.
  fix Ensure `restifizer.resources` is invoked as a function with an array of resource configurations, for example: `app.use(restifizer.resources([...]))`. Verify that your Express.js version is compatible with this older library, which is a common challenge for abandoned packages.

• MongooseError: Model.find() no longer accepts a callback

  cause This issue arises when the version of Mongoose being used by `restifizer-mongoose-ds` is too old for your current Mongoose installation, or vice-versa. Mongoose has undergone significant API changes in recent versions, particularly concerning callback-based methods, which an older library like `restifizer` might still rely on.
  fix This problem is difficult to resolve without modifying the `restifizer-mongoose-ds` source code. It highlights the inherent incompatibility of abandoned libraries with evolving ecosystems. Downgrading Mongoose to a much older version (e.g., Mongoose 4.x or 5.x) might provide a temporary workaround, but this is generally not recommended due to potential security vulnerabilities and lack of modern features.

Warnings

• breaking The `restifizer` package has not been updated since version 0.8.36, published 7 years ago (as of 2024). This makes it highly likely to be incompatible with modern Node.js versions (e.g., Node.js 16+), Express.js (v5+), and current versions of its data source dependencies (Mongoose 6+/7+, Sequelize 6+/7+). Significant breaking changes in these underlying libraries are not addressed.
  Fix: Consider migrating to an actively maintained, modern REST API framework like NestJS, Express with custom routing, or a direct ORM solution like TypeORM/Prisma with a framework like Fastify or Koa. If using this library is unavoidable, extensive testing and potential patching for compatibility will be required.
• gotcha By default, Restifizer exposes the underlying ORM's querying engine directly via HTTP requests (e.g., using the `filter` parameter). This allows querying on any database field, which can lead to severe performance bottlenecks and potential denial-of-service attacks if unindexed fields are queried on large datasets in production environments.
  Fix: Explicitly define `allowedFilterFields` for each resource to restrict queryable fields to only those that are indexed in your database. Rigorously review and configure all security and performance settings before deployment.
• deprecated As an abandoned project, Restifizer will not receive security patches, bug fixes, or new features. Using it in production environments introduces significant security risks due to unpatched vulnerabilities in the package itself or its dependencies, as well as potential compatibility issues.
  Fix: Strongly recommend against using this library for new projects or in production environments. Migrate existing applications to actively maintained alternatives to ensure security, stability, and ongoing compatibility with the JavaScript ecosystem.

Install

• npm install restifizer npm
• yarn add restifizer yarn
• pnpm add restifizer pnpm

Imports

• restifizer
  wrong:

  import restifizer from 'restifizer';

  correct:

  const restifizer = require('restifizer');

  This library is CommonJS-only, as it was last updated before widespread ESM adoption in Node.js. Direct ESM imports will fail.
• RestifizerMongooseDataSource
  wrong:

  import { RestifizerMongooseDataSource } from 'restifizer-mongoose-ds';

  correct:

  const RestifizerMongooseDataSource = require('restifizer-mongoose-ds');

  Data source modules like `restifizer-mongoose-ds` are separate CommonJS packages that must be explicitly required.
• resources
  wrong:

  app.use(restifizer([...]));

  correct:

  app.use(restifizer.resources([...]));

  The main entry point for defining REST resources is typically `restifizer.resources()`, which returns an Express middleware function. It is not the `restifizer` object itself.

Quickstart

This quickstart demonstrates setting up an Express application with Restifizer and Mongoose. It defines a 'User' resource, connects to a MongoDB database, and shows how to use Restifizer to expose basic CRUD operations via HTTP, including an example of restricted filtering.

const express = require('express');
const mongoose = require('mongoose');
const restifizer = require('restifizer');
const RestifizerMongooseDataSource = require('restifizer-mongoose-ds');

const app = express();
const PORT = process.env.PORT || 3000;

// 1. Connect to MongoDB
mongoose.connect(process.env.MONGO_URI || 'mongodb://localhost:27017/restifizer_example')
  .then(() => console.log('MongoDB connected'))
  .catch(err => console.error('MongoDB connection error:', err));

// 2. Define a Mongoose Schema and Model
const UserSchema = new mongoose.Schema({
  username: { type: String, required: true, unique: true },
  email: { type: String, required: true, unique: true },
  createdAt: { type: Date, default: Date.now }
});
const User = mongoose.model('User', UserSchema);

// 3. Configure Restifizer resources
app.use(express.json()); // For parsing application/json
app.use(restifizer.resources([
  {
    path: '/api/users',
    model: User,
    dataSource: RestifizerMongooseDataSource,
    // Example: allow filtering only on indexed fields for performance/security
    allowedFilterFields: ['username', 'email']
  }
]));

// 4. Start the Express server
app.listen(PORT, () => {
  console.log(`Server running on http://localhost:${PORT}`);
  console.log('To test, use a tool like HTTPie or curl:');
  console.log(`http POST http://localhost:${PORT}/api/users username='testuser' email='test@example.com'`);
  console.log(`http GET http://localhost:${PORT}/api/users`);
  console.log(`http GET http://localhost:${PORT}/api/users?filter=\"{\"username\":\"testuser\"}\"`);
});