3.0.2 • Published 5 months ago

@agabidullin/next-crud v3.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

Next Crud

NPM Version NPM License Github Actions

next-crud is a helper library that creates CRUD API routes with one simple function based on a Prisma model for Next.js.

Starting from version 3 of the lib, we only support Prisma v5 and above. Please install version 2 of the lib if you are using Prisma v4 or older.

Documentation

The documentation is available here

Overview

yarn add @premieroctet/next-crud

Given the following Prisma schema:

model User {
  id              Int        @id @default(autoincrement())
  name            String?
  email           String?
}

Create the file /pages/api/[...nextcrud].ts. with:

import NextCrud, { PrismaAdapter } from '@premieroctet/next-crud'
import { NextApiRequest, NextApiResponse } from 'next'

const handler = async (req: NextApiRequest, res: NextApiResponse) => {
  const nextCrudHandler = await NextCrud({
    adapter: new PrismaAdapter({
      prismaClient: myPrismaClientInstance,
    }),
  })

  return nextCrudHandler(req, res)
}

export default handler

And get your full featured CRUD routes!

EndpointDescription
ListGET /api/usersGet all the users
GetGET /api/users/[id]Get one user
AddPOST /api/usersCreate one user
EditPUT /api/users/[id]Update one user
Partial editPATCH /api/users/[id]Update one user (partial)
DeleteDELETE/api/users/[id]Delete one user

Example

Open in CodeSandbox

Contributing

You can run the example project to test your modifications. Make sure to run yarn watch in the root folder.

3.0.2

5 months ago

3.0.1

5 months ago

3.0.0

6 months ago