├── .gitignore
├── .vscode
└── settings.json
├── README.md
├── old
├── package.json
├── prisma
├── dev.db
├── migrations
│ ├── 20230224160826_init
│ │ └── migration.sql
│ └── migration_lock.toml
├── schema.prisma
└── seed.ts
├── src
├── apis
│ ├── Cache.ts
│ ├── HttpMethods.ts
│ ├── Naming.ts
│ ├── Optimization.ts
│ └── StatusCodes.ts
├── app.ts
└── index.ts
├── tsconfig.json
└── yarn.lock
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules/
2 | dist/
3 | *.env*
4 |
--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | "jira-plugin.workingProject": ""
3 | }
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # REST API Example
2 |
3 | This example shows how to implement a **REST API with TypeScript** using [Express](https://expressjs.com/) and [Prisma Client](https://www.prisma.io/docs/concepts/components/prisma-client). The example uses an SQLite database file with some initial dummy data which you can find at [`./prisma/dev.db`](./prisma/dev.db).
4 |
5 | ## Getting started
6 |
7 | ### 1. Download example and install dependencies
8 |
9 | Download this example:
10 |
11 | ```
12 | npx try-prisma --template typescript/rest-express
13 | ```
14 |
15 | Install npm dependencies:
16 |
17 | ```
18 | cd rest-express
19 | npm install
20 | ```
21 |
22 | Alternative: Clone the entire repo
23 |
24 | Clone this repository:
25 |
26 | ```
27 | git clone git@github.com:prisma/prisma-examples.git --depth=1
28 | ```
29 |
30 | Install npm dependencies:
31 |
32 | ```
33 | cd prisma-examples/typescript/rest-express
34 | npm install
35 | ```
36 |
37 | Expand to view more sample Prisma Client queries on Profile
188 |
189 | Here are some more sample Prisma Client queries on the new Profile model:
190 |
191 | ##### Create a new profile for an existing user
192 |
193 | ```ts
194 | const profile = await prisma.profile.create({
195 | data: {
196 | bio: 'Hello World',
197 | user: {
198 | connect: { email: 'alice@prisma.io' },
199 | },
200 | },
201 | })
202 | ```
203 |
204 | ##### Create a new user with a new profile
205 |
206 | ```ts
207 | const user = await prisma.user.create({
208 | data: {
209 | email: 'john@prisma.io',
210 | name: 'John',
211 | profile: {
212 | create: {
213 | bio: 'Hello World',
214 | },
215 | },
216 | },
217 | })
218 | ```
219 |
220 | ##### Update the profile of an existing user
221 |
222 | ```ts
223 | const userWithUpdatedProfile = await prisma.user.update({
224 | where: { email: 'alice@prisma.io' },
225 | data: {
226 | profile: {
227 | update: {
228 | bio: 'Hello Friends',
229 | },
230 | },
231 | },
232 | })
233 | ```
234 |
235 | Expand for an overview of example configurations with different databases
244 |
245 | ### PostgreSQL
246 |
247 | For PostgreSQL, the connection URL has the following structure:
248 |
249 | ```prisma
250 | datasource db {
251 | provider = "postgresql"
252 | url = "postgresql://USER:PASSWORD@HOST:PORT/DATABASE?schema=SCHEMA"
253 | }
254 | ```
255 |
256 | Here is an example connection string with a local PostgreSQL database:
257 |
258 | ```prisma
259 | datasource db {
260 | provider = "postgresql"
261 | url = "postgresql://janedoe:mypassword@localhost:5432/notesapi?schema=public"
262 | }
263 | ```
264 |
265 | ### MySQL
266 |
267 | For MySQL, the connection URL has the following structure:
268 |
269 | ```prisma
270 | datasource db {
271 | provider = "mysql"
272 | url = "mysql://USER:PASSWORD@HOST:PORT/DATABASE"
273 | }
274 | ```
275 |
276 | Here is an example connection string with a local MySQL database:
277 |
278 | ```prisma
279 | datasource db {
280 | provider = "mysql"
281 | url = "mysql://janedoe:mypassword@localhost:3306/notesapi"
282 | }
283 | ```
284 |
285 | ### Microsoft SQL Server
286 |
287 | Here is an example connection string with a local Microsoft SQL Server database:
288 |
289 | ```prisma
290 | datasource db {
291 | provider = "sqlserver"
292 | url = "sqlserver://localhost:1433;initial catalog=sample;user=sa;password=mypassword;"
293 | }
294 | ```
295 |
296 | ### MongoDB
297 |
298 | Here is an example connection string with a local MongoDB database:
299 |
300 | ```prisma
301 | datasource db {
302 | provider = "mongodb"
303 | url = "mongodb://USERNAME:PASSWORD@HOST/DATABASE?authSource=admin&retryWrites=true&w=majority"
304 | }
305 | ```
306 |
307 |