RESTful Interfaces

Models

Create a Next.js application, then install Prisma and initialize it with a SQLite data source provider. Define the following models in prisma/schema.prisma and use cuid(2) to generate the identifiers:

Define a seeding script, prisma/seed.mjs, to create all valid card types. CardType is conceptually an enumeration but is defined as a model instead:

Create the database using a migration, seed it, and verify that it has been created and seeded successfully using Prisma Studio.

Endpoints

Define the following routes and methods to manage the collection of decks, slides, and cards:

Do not access the database directly in the route methods. Instead, use CRUD repositories with corresponding methods for all data operations. Each route method should require only one repository method call.

Respond with the correct status code (opens in a new tab) for successful requests (2xx). For invalid requests, respond with an error status code (4xx, 5xx) and a message. Examples of invalid requests include:

• Accessing a non-existent resource.
• Deleting a non-empty deck or slide.
• Deleting a card from a slide that does not contain it.

You can use the Prisma error code (opens in a new tab) to determine the type of error that occurred in the repository method and respond accordingly. Error details are provided by the repository methods (see Repositories below).

export async function METHOD(request, { params }) {
  try {
    const { ••• } = await params;
    const result = await •••
    if ("error" in result) {
      return Response.json(•••);
    }
    return Response.json(•••);
  } catch (e) {
    return Response.json(•••);
  }
}

Repositories

Create separate data repository modules under repos for decks, slides, and cards, respectively. These repository modules import Prisma Client and use its CRUD operations (opens in a new tab) to access the underlying database, implementing only the methods needed by the route methods.

Repository methods return the result of their database queries. When a query fails, an exception is thrown by Prisma Client with a corresponding error code (opens in a new tab). Use this code to return an error object, which the route method then uses to respond accordingly.

export async function method(•••) {
  try {
    const verification = await •••
    const result = await •••
    return {
      data: •••
    };
  } catch (e) {
    return {
      error: {
        message: •••,
        status: •••
      }
    };
  }
}

Despite the fact that each deck, slide, and card is uniquely identified by its cuid, every repository method must verify ownership before executing its query:

• Every method in repos/slides.js must verify that the slide belongs to the specified deck.
• Every method in repos/cards.js must verify that the card belongs to the specified slide and that the slide belongs to the specified deck.

An error is returned when verification fails. This ensures that each resource is accessed using a single unique URL given our route interface.

Testing

Test all ten route methods using Postman and export the collection to postman.json.