Type Name Latest commit message Commit time
Failed to load latest commit information.
prisma remove dangling endpoints Nov 26, 2018
src prettier Nov 26, 2018 update docker versions Dec 4, 2018
package.json Update dependency prisma-client-lib to v1.22.2 Dec 7, 2018

REST API Example

This example shows how to implement a REST API using Express.JS and Prisma.

How to use

1. Download example & install dependencies

Clone the repository:

git clone

Install Node dependencies:

cd prisma-examples/node/rest-express
npm install

2. Install the Prisma CLI

To run the example, you need the Prisma CLI. Please install it via NPM or using another method:

npm install -g prisma

3. Set up database & deploy Prisma datamodel

For this example, you'll use a free demo database (AWS Aurora) hosted in Prisma Cloud. To set up your database, run:

prisma deploy

Then, follow these steps in the interactive CLI wizard:

  1. Select Demo server
  2. Authenticate with Prisma Cloud in your browser (if necessary)
  3. Back in your terminal, confirm all suggested values
Alternative: Run Prisma locally via Docker
  1. Ensure you have Docker installed on your machine. If not, you can get it from here.
  2. Create docker-compose.yml for MySQL (see here for Postgres):
    version: '3'
        image: prismagraphql/prisma:1.22
        restart: always
        - "4466:4466"
          PRISMA_CONFIG: |
            port: 4466
                connector: mysql
                host: mysql
                port: 3306
                user: root
                password: prisma
                migrations: true
        image: mysql:5.7
        restart: always
          MYSQL_ROOT_PASSWORD: prisma
          - mysql:/var/lib/mysql
  3. Run docker-compose up -d
  4. Run prisma deploy

4. Start the REST API server

yarn start

The server is now running on http://localhost:3000. You can send the API requests implemented in index.js, e.g. http://localhost:3000/feed.

5. Using the REST API


  • /post/:id: Fetch a single post by its id
  • /feed: Fetch all published posts
  • /filterPosts?searchString={searchString}: Filter posts by title or content


  • /post: Create a new post
    • Body:
      • title: String (required): The title of the post
      • content: String (optional): The content of the post
      • authorEmail: String (required): The email of the user that creates the post
  • /user: Create a new user
    • Body:
      • email: String (required): The email address of the user
      • name: String (optional): The name of the user


  • /publish/:id: Publish a post by its id


  • /post/:id: Delete a post by its id

Next steps