Welcome to Build and Deploy a REST API with Deno!

How to Install Deno Locally and in Docker Containers

Introduction

Deno vs Node: A Deno Fresh Start to JavaScript Runtimes

How to Use the Deno REPL Command Line Interface

Executing TypeScript Files With Deno With the Config File

Deno vs Golang's Standard Library

How to Start a Deno Server and Set Permissions

How to Build a Token Authentication Server With Deno

Getting Started with Deno

Using Databases with Deno

How to Use PostgreSQL in Docker with Deno

How to Integrate MySQL or MariaDB With Deno

How to Add SQLite to Deno with deno-sqlite

Connect to a database

What is Database Migration? The Strategy to Migrate Data

How to Add Nessie to Deno to Migrate Databases

How to Create a New Database Migration With Deno Nessie

Edit a Deno Nessie Database Migration to Catch Errors

How to Run and Roll Back a Database Migration With Deno Nessie

How to Create a Database Seed File With Deno Nessie

How to Import JSON Data and Seed a Database With Deno Nessie

Database migrations

REST API Introduction

Best Practices for a REST API: Endpoints and Database Schema

How to Prepare Deno to Build a REST API

How to Build REST API Endpoints in Deno

Integrate a PostgreSQL Database With Nessie Into a Deno API

Building a MySQL or PostgreSQL Database Pool in Deno

Migrating Data to PostgreSQL and Modeling Data in Deno

Build API Calls That Generate SQL Queries in Deno

Create a Database Controller in Deno

How to Authenticate and Authorize REST API Requests in Deno

Create New Tables and Models With Deno Database Migration

Add List, Create, Read, Update, and Delete Requests in Deno

How to Build Many-to-Many Namespace Connections in Deno

API Afterthoughts

REST API

Deployment Introduction

How to Create a Docker Image to Containerize an Application

How to Create Continuous Integration Files for GitHub and GitLab

How to Deploy a Deno API Server With the Digital Ocean API

How to Deploy a Deno Docker Image to Digital Ocean

Deploy with Docker

Deployment

deno

In this course, we will learn how to work with [Deno](https://deno.land) to create a REST API using TypeScript with the web framework [Oak](https://github.com/oakserver/oak) and the migration tool [Nessie](https://github.com/halvardssm/deno-nessie). 
Deno is a JavaScript runtime created by [Ryan Dahl](https://tinyclouds.org), the same creator for Node, as an attempt to simplify the JavaScript landscape by strictly following the WebAPI specs. 
If you are interested in learning more about the motivation behind Deno, you can watch this video where Ryan Dahl explains "[10 Things I Regret About Node.js](https://www.youtube.com/watch?v=M3BM9TB-8yA)"

We will explore how to create an application using the powers of TypeScript, and learn how to traverse the Deno ecosystem which is much like the native web ecosystem. 
There are 5 modules that will take you from installing Deno and running your first lines of code, to working with web frameworks and databases, and in the end, deploying your application to a web server using a deployment pipeline.

Throughout this course, you will experience all the different aspects of Deno which you will need to create your own application in the future. 
And from this course, you will get a good feeling for if Deno is ready to be your next default for new projects.

In this course, we will learn how to create and deploy a REST API with Deno from scratch.

Build and deploy a REST API with Deno

Integrating databases into your application

Importance of database migrations in production applications

Deploying Deno applications to production using CICD

Before going any further, it's important that we take time to plan the project,
to get an understanding of what will be needed. This should always be the first
step when creating an application: deciding the scope and potentially required
features. I like to do this with the following three steps, but everyone works
differently, so find the way which is best for you:

Sometimes I switch 2 and 3 depending on the project, which will be the case
for this project.

By planning out your project like this, you'll save a lot of time down the line
when you come to develop the application, as you will have a blueprint to
follow.

We will continue our idea from the last module for a bare bones Twitter clone
which we will call Quacker 🦆.

 (tweet) board which will list recent
Quacks in descending order (most recent first). It will also allow for a new
Quack submission from any logged in 

 (users), and of course allow for a
Duck to register and log in. You should also allow for each Quack to receive a

 (like), so we need to keep track of which Duck has given Crumbs to
which Quacks. Lastly we also want a 

 (status) endpoint to check if
our application is running.

From the information above, we can deduce that our application will need the
following endpoints:

| Endpoint           | Method | Description                        | Authorization  |
| ------------------ | ------ | ---------------------------------- | -------------- |
| `/duck`            | POST   | Create duck                        | Public         |
| `/duck/:id`        | GET    | Get duck                           | Self           |
| `/duck/:id`        | PUT    | Update duck                        | Self           |
| `/duck/:id`        | DELETE | Delete duck                        | Self           |
| `/quack`           | GET    | List entries                       | Public         |
| `/quack`           | POST   | Create quack                       | Self           |
| `/quack/:id`       | GET    | Get quack                          | Public         |
| `/quack/:id`       | PUT    | Update quack                       | Self           |
| `/quack/:id`       | DELETE | Delete quack                       | Self           |
| `/quack/:id/crumb` | PUT    | Add or remove a crumb from a quack | Logged in Duck |
| `/login`           | POST   | Log in the duck                    | Public         |
| `/health-check`    | GET    | Get status of application          | Public         |

---
title: Planning
description: We will go through the thought process of planning an application.
---

## Planning

Before going any further, it's important that we take time to plan the project,
to get an understanding of what will be needed. This should always be the first
step when creating an application: deciding the scope and potentially required
features. I like to do this with the following three steps, but everyone works
differently, so find the way which is best for you:

1.  Decide on features
2.  Create a database diagram
3.  Plan endpoints

> Sometimes I switch 2 and 3 depending on the project, which will be the case
> for this project.

By planning out your project like this, you'll save a lot of time down the line
when you come to develop the application, as you will have a blueprint to
follow.

### The grand plan

We will continue our idea from the last module for a bare bones Twitter clone
which we will call Quacker 🦆.

#### Features

The application will consist of a **Quack** (tweet) board which will list recent
Quacks in descending order (most recent first). It will also allow for a new
Quack submission from any logged in **Ducks** (users), and of course allow for a
Duck to register and log in. You should also allow for each Quack to receive a
**Crumb** (like), so we need to keep track of which Duck has given Crumbs to
which Quacks. Lastly we also want a `health-check` (status) endpoint to check if
our application is running.

#### Endpoints

From the information above, we can deduce that our application will need the
following endpoints:

```text { actualFilename=./public/assets/snippets.txt endLine=43 startLine=30 url=https&#x3A;//gitlab.com/fullstackio/books/build-and-deploy-a-rest-api-with-deno/module_04/lesson_01/public/assets/snippets.txt#L30 }
| Endpoint           | Method | Description                        | Authorization  |
| ------------------ | ------ | ---------------------------------- | -------------- |
| `/duck`            | POST   | Create duck                        | Public         |
| `/duck/:id`        | GET    | Get duck                           | Self           |
| `/duck/:id`        | PUT    | Update duck                        | Self           |
| `/duck/:id`        | DELETE | Delete duck                        | Self           |
| `/quack`           | GET    | List entries                       | Public         |
| `/quack`           | POST   | Create quack                       | Self           |
| `/quack/:id`       | GET    | Get quack                          | Public         |
| `/quack/:id`       | PUT    | Update quack                       | Self           |
| `/quack/:id`       | DELETE | Delete quack                       | Self           |
| `/quack/:id/crumb` | PUT    | Add or remove a crumb from a quack | Logged in Duck |
| `/login`           | POST   | Log in the duck                    | Public         |
| `/health-check`    | GET    | Get status of application          | Public         |
```

We will go through the thought process of planning an application.

What software did you use to draw the database schema diagram?

Michael DiStefano

Hi Michael! I think I used dbdiagram.io but dont fully remember, but there are many others which you can use.

Learn

The newline Guide to Building Your First GraphQL Server with Node and TypeScript

Teach

Amelia Wattenberger

Author of Fullstack D3

Community

Build and deploy a REST API with Deno

Module 1: Introduction

Introduction:

Start Here

Introduction:

Welcome to Build and Deploy a REST API with Deno!

Lesson:

How to Install Deno Locally and in Docker Containers

Module 2: Getting Started with Deno

Introduction:

Deno vs Node: A Deno Fresh Start to JavaScript Runtimes

Lesson 1:

How to Use the Deno REPL Command Line Interface

Lesson 2:

Executing TypeScript Files With Deno With the Config File

Lesson 3:

Deno vs Golang's Standard Library

Lesson 4:

How to Start a Deno Server and Set Permissions

Lesson 5:

How to Build a Token Authentication Server With Deno

Module 3: Connect to a database

Introduction:

Using Databases with Deno

Lesson 1:

How to Use PostgreSQL in Docker with Deno

Lesson 2:

How to Integrate MySQL or MariaDB With Deno

Lesson 3:

How to Add SQLite to Deno with deno-sqlite

Module 4: Database migrations

Introduction:

What is Database Migration? The Strategy to Migrate Data

Lesson 1:

How to Add Nessie to Deno to Migrate Databases

Lesson 2:

How to Create a New Database Migration With Deno Nessie

Lesson 3:

Edit a Deno Nessie Database Migration to Catch Errors

Lesson 4:

How to Run and Roll Back a Database Migration With Deno Nessie

Lesson 5:

How to Create a Database Seed File With Deno Nessie

Lesson 6:

How to Import JSON Data and Seed a Database With Deno Nessie

Module 5: REST API

Introduction:

REST API Introduction

Lesson 1:

Best Practices for a REST API: Endpoints and Database Schema

Lesson 2:

How to Prepare Deno to Build a REST API

Lesson 3:

How to Build REST API Endpoints in Deno

Lesson 4:

Integrate a PostgreSQL Database With Nessie Into a Deno API

Lesson 5:

Building a MySQL or PostgreSQL Database Pool in Deno

Lesson 6:

Migrating Data to PostgreSQL and Modeling Data in Deno

Lesson 7:

Build API Calls That Generate SQL Queries in Deno

Lesson 8:

Create a Database Controller in Deno

Lesson 9:

How to Authenticate and Authorize REST API Requests in Deno

Lesson 10:

Create New Tables and Models With Deno Database Migration

Lesson 11:

Add List, Create, Read, Update, and Delete Requests in Deno

Lesson 12:

How to Build Many-to-Many Namespace Connections in Deno

Lesson 1:

API Afterthoughts