This example shows how to implement a REST API with TypeScript using Express and Prisma Client. The example uses an SQLite database file with some initial dummy data which you can find at ./prisma/dev.db.
Download this example:
npx try-prisma --template typescript/rest-expressInstall npm dependencies:
cd rest-express
npm installRun the following command to create your SQLite database file. This also creates the User and Post tables that are defined in prisma/schema.prisma:
npx prisma migrate dev --name initWhen npx prisma migrate dev is executed against a newly created database, seeding is also triggered. The seed file in prisma/seed.ts will be executed and your database will be populated with the sample data.
npm run devThe server is now running on http://localhost:3000. You can now run the API requests, e.g. http://localhost:3000/feed.
You can access the REST API of the server using the following endpoints:
GET/post/:id: Fetch a single post by its id
/feed?searchString={searchString}&take={take}&skip={skip}&orderBy={orderBy}: Fetch all published posts
searchString (optional): This filters posts by title or contenttake (optional): This specifies how many objects should be returned in the listskip (optional): This specifies how many of the returned objects in the list should be skippedorderBy (optional): The sort order for posts in either ascending or descending order. The value can either asc or desc/user/:id/drafts: Fetch user's drafts by their id
/users: Fetch all users
POST/post: Create a new post
title: String (required): The title of the postcontent: String (optional): The content of the postauthorEmail: String (required): The email of the user that creates the post/signup: Create a new user
email: String (required): The email address of the username: String (optional): The name of the userpostData: PostCreateInput[] (optional): The posts of the userPUT/publish/:id: Toggle the publish value of a post by its id/post/:id/views: Increases the viewCount of a Post by one idDELETE/post/:id: Delete a post by its idEvolving the application typically requires two steps:
For the following example scenario, assume you want to add a "profile" feature to the app where users can create a profile and write a short bio about themselves.
The first step is to add a new table, e.g. called Profile, to the database. You can do this by adding a new model to your Prisma schema file file and then running a migration afterwards:
// ./prisma/schema.prisma
model User {
id Int @default(autoincrement()) @id
name String?
email String @unique
posts Post[]
+ profile Profile?
}
model Post {
id Int @id @default(autoincrement())
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
title String
content String?
published Boolean @default(false)
viewCount Int @default(0)
author User? @relation(fields: [authorId], references: [id])
authorId Int?
}
+model Profile {
+ id Int @default(autoincrement()) @id
+ bio String?
+ user User @relation(fields: [userId], references: [id])
+ userId Int @unique
+}Once you've updated your data model, you can execute the changes against your database with the following command:
npx prisma migrate dev --name add-profileThis adds another migration to the prisma/migrations directory and creates the new Profile table in the database.
You can now use your PrismaClient instance to perform operations against the new Profile table. Those operations can be used to implement API endpoints in the REST API.
Update your index.ts file by adding a new endpoint to your API:
app.post('/user/:id/profile', async (req, res) => {
const { id } = req.params
const { bio } = req.body
const profile = await prisma.profile.create({
data: {
bio,
user: {
connect: {
id: Number(id)
}
}
}
})
res.json(profile)
})Restart your application server and test out your new endpoint.
POST/user/:id/profile: Create a new profile based on the user id
bio: String : The bio of the userProfileProfile model:
##### Create a new profile for an existing user
```ts
const profile = await prisma.profile.create({
data: {
bio: 'Hello World',
user: {
connect: { email: 'alice@prisma.io' },
},
},
})
```
##### Create a new user with a new profile
```ts
const user = await prisma.user.create({
data: {
email: 'john@prisma.io',
name: 'John',
profile: {
create: {
bio: 'Hello World',
},
},
},
})
```
##### Update the profile of an existing user
```ts
const userWithUpdatedProfile = await prisma.user.update({
where: { email: 'alice@prisma.io' },
data: {
profile: {
update: {
bio: 'Hello Friends',
},
},
},
})
```
If you want to try this example with another database than SQLite, you can adjust the the database connection in prisma/schema.prisma by reconfiguring the datasource block.
Learn more about the different connection configurations in the docs.
#product-wishlist channel on the Prisma Slack