Skip to content
Building RESTful Web APIs with Node.js, Express, MongoDB and TypeScript
Branch: master
Clone or download
Latest commit b92c694 Jan 27, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Added documentation Jan 27, 2019
config Added HTTPS to API application Jun 3, 2018
docs Added documentation Jan 27, 2019
lib Update app.ts Jan 19, 2019
public Added static folder and files Apr 15, 2018
.gitignore Added documentation Jan 27, 2019
README.md Update npm packages Jan 27, 2019
package-lock.json
package.json Update npm packages Jan 27, 2019
requirements.txt Added documentation Jan 27, 2019
tsconfig.json Used typescript with express Apr 15, 2018

README.md

Building RESTful Web APIs with Node.js, Express, MongoDB and TypeScript

This is a simple API that saves contact information of people.

There are two versions of this project.

  • V1.0.0: you can run the server directly after cloning this version. It will create a simple RESTful API over HTTP.
  • V2.0.0: this is a more secure and control API project. You need to read the post on how to secure RESTful API application first. After that, you can run the project.

Requirements

NodeJS

Install global TypeScript and TypeScript Node

npm install -g typescript ts-node

Getting Started

You should install MongoDB on your local machine, or use other services such as mLab or Compose

After that, you will have to replace the mongoURL with your MongoDB address in lib/app.ts

Clone this repository

git clone git@github.com:dalenguyen/rest-api-node-typescript.git .

Then install the dependencies

npm install

Start the server

Run in development mode

npm run dev

Run in production mode

npm run prod

Testing over HTTP (tag v1.0.0)

The default URL is: http://localhost:3000

  • GET all contacts
Send GET request to http://localhost:3000/contact/

Testing over HTTPs (tag v2.0.0)

The default URL is: https://localhost:3000

The key and cert in the config folder is for testing purpose only. You should generate your own.

Reference from Lynda.com

You can’t perform that action at this time.