What You Get

Automatically exposed CRUD API endpoints.

📝 Exposed API Endpoints

GET    /api/{model}      # List all
POST   /api/{model}      # Create
GET    /api/{model}/:id  # Get one
PATCH  /api/{model}/:id  # Update
DELETE /api/{model}/:id  # Delete

📊 Example Model

users → /api/users

GET    /api/users      # List all users
POST   /api/users      # Create user
GET    /api/users/1    # Get one user
PATCH  /api/users/1    # Update user
DELETE /api/users/1    # Delete user

🔒 Protected Fields

By default, the following fields cannot be updated:

id
createdAt
created_at

🎨 Custom Restrictions (Optional)

To customize which fields are updatable for a model, update customUpdatableFields in server/utils/modelMapper.ts:

// server/utils/modelMapper.ts
export const customUpdatableFields = {
  users: ["name", "avatar"], // Only these fields
};

💡 Key Features

✅ Auto-discovers models from the schema
✅ Auto-detects updatable fields
✅ Smart naming with pluralization
✅ Zero configuration required

Just add a schema → Run the migration → Done!

Install Auto CRUD

Install the nuxt module nuxt-auto-crud