Introduction to the newline guide to building and deploying a REST API using Deno.

Welcome to Build and Deploy a REST API with Deno!

In this lesson, we will install Deno and create our setup for the rest of the course.

How to Install Deno Locally and in Docker Containers

Introduction

Deno vs Node: A Deno Fresh Start to JavaScript Runtimes

We will look at the command line interface for running Deno

How to Use the Deno REPL Command Line Interface

In this lesson, we will look at general usage of Deno by running a file and also introduce the config file

Executing TypeScript Files With Deno With the Config File

Learn how to use the Deno standard library and other external modules with URL imports

Deno vs Golang's Standard Library

How to Start a Deno Server and Set Permissions

You will learn how to make a simple token authentication in Deno

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

Introduction to database migrations - what, why and how

What is Database Migration? The Strategy to Migrate Data

Get started with database migrations using Nessie

How to Add Nessie to Deno to Migrate Databases

We will go through creating a migration using the Nessie CLI

How to Create a New Database Migration With Deno Nessie

We will look at how to write a migration script where we create a table

Edit a Deno Nessie Database Migration to Catch Errors

We will run our migration and learn how to roll back the migration

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

We will create a seed file using the Nessie CLI

How to Create a Database Seed File With Deno Nessie

We will run our seed file and populate our database

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

Database migrations

Introduction to the concept of REST APIs and why we use them

REST API Introduction

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

Best Practices for a REST API: Endpoints and Database Schema

We will create the initial project files and set up our environment

How to Prepare Deno to Build a REST API

We will create the router and look at how to test our endpoints

How to Build REST API Endpoints in Deno

It's time to add Nessie! We will now initialize Nessie in our project and also spin up our development database

Integrate a PostgreSQL Database With Nessie Into a Deno API

Time to connect our models to our database!

Building a MySQL or PostgreSQL Database Pool in Deno

In this step, we will create our first data model and create a corresponding table using a migration

Migrating Data to PostgreSQL and Modeling Data in Deno

Creating the methods to access the database

Build API Calls That Generate SQL Queries in Deno

Creating the server endpoints for the Duck namespace

Create a Database Controller in Deno

We will look at how to set up authentication and further authorize the requests

How to Authenticate and Authorize REST API Requests in Deno

We will create two new tables using a migration and create the equivalent models

Create New Tables and Models With Deno Database Migration

We will create our Quack service and controller

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

The last stretch! We will create our final namespace, Crumb, and connect it to our other models and our router

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

Now that our application is completed, we will consider some improvements and discuss alternative approaches.

API Afterthoughts

REST API

We will introduce deployments and what we will learn in this module

Deployment Introduction

We will create a Docker image for our application

How to Create a Docker Image to Containerize an Application

You will learn how to create a basic CI file for GitHub and GitLab, and run tests on them

How to Create Continuous Integration Files for GitHub and GitLab

We will deploy our application to a server using CI, SSH and git.

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

We will deploy our application to Digital Ocean Apps. This is by far the easiest (but most costly) approach.

How to Deploy a Deno Docker Image to Digital Ocean

Similar to how we did it in lesson 1, we will be deploying using CI and SSH, but instead of git, we will be using Docker.

Deploy with Docker

Deployment

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: "Best Practices for a REST API: Endpoints and Database Schema"
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-a-rest-api-with-deno-and-postgresql/module_05/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         |
```