Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Conferences
Free Learning
Arrow right icon
RESTful Web API Design with Node.js 10, Third Edition
RESTful Web API Design with Node.js 10, Third Edition

RESTful Web API Design with Node.js 10, Third Edition: Learn to create robust RESTful web services with Node.js, MongoDB, and Express.js , Third Edition

eBook
$9.99 $25.99
Paperback
$32.99
Subscription
Free Trial
Renews at $19.99p/m

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing
Table of content icon View table of contents Preview book icon Preview Book

RESTful Web API Design with Node.js 10, Third Edition

Getting Started with Node.js

In this chapter, you will gain your first real Node.js experience. We will start by installing Node.js, along with some modules we will use throughout this book. Then, we will set up a development environment. Throughout the book, the Atom IDE will be used. Yes, GitHub's online editor has finally landed for desktop environment and is available on a platform of your preference!

Next, we will create a workspace and start developing our first Node.js application. It will be a simple server application processing incoming HTTP requests. We will go one step further, demonstrating how to modularize and unit test our JavaScript code. Finally, we will deploy our first application on the Heroku Cloud Application platform.

To sum up, in this chapter, we will cover the following topics:

  • Installing Node.js
  • Installing the Express framework and other modules...

Installing Node.js

Let's start our journey through Node.js with a Node.js installation. Installers are available for both Windows and macOS at https://nodejs.org/en/download/.  At the time of writing, Node.js 10 has just been released as the current version, and is about to become the next Long Term Support version, in August 2018. Linux users can either build Node.js from the available Linux binaries or make use of their package manager, as Node.js is available with most of the popular package repositories for different Linux distributions. For instance, Ubuntu and other Debian-based distributions should first point to the latest Node.js 10 package and then install via the apt-get command from the shell:

curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install nodejs

If you decide to go with an installer available for macOS or Windows...

Installing the Express framework and other modules

Now that we have npm installed, let's make use of it and install some of the modules we will be using heavily throughout this book. The most important among them is the Express framework (http://www.expressjs.com/). It is a flexible web application framework for Node.js, providing a robust RESTful API for developing single or multi-page web applications. The following command will download the Express module from the npm repository and make it available for our local Node.js installation:

npm install -g express 

You will find the express module among the results of an npm ls after a successful installation. Later in this chapter, we will learn how to write unit tests for our Node.js modules. We will need the nodeunit module for that purpose:

npm install nodeunit -g 

The -g option will install nodeunit globally....

Setting up a development environment

JavaScript developers are rarely used to developing their projects in an IDE; most of them use text editors and tend to be prejudiced against anything that contradicts their views. GitHub has finally managed to calm most of them down by releasing the Atom IDE for the desktop environment. This may not solve all of the arguments about which is the best environment, but will at least bring some peace, and let people concentrate on their code, not on the tooling, which in the end is a matter of personal preference. The samples in this book are developed in the Atom IDE, but feel free to use any piece of software that can create files, including command-line editors such as vi or vim, if that would make you feel like a JS superhero, though bear in mind that superheroes are so 20th century!

You can download the Atom IDE from https://ide.atom.io/...

Handling HTTP requests

Currently, our server application will behave in the same way, no matter what kind of HTTP request is processed. Let's extend it in such a way that it behaves more like an HTTP server, and start differentiating the incoming requests based on their type, by implementing handler functions for each type of request.

Let's create a new hello-node-http-server.js as follows:

var http = require('http');
var port = 8180;

function handleGetRequest(response) {
response.writeHead(200, {'Content-Type' : 'text/plain'});
response.end('Get action was requested');
}

function handlePostRequest(response) {
response.writeHead(200, {'Content-Type' : 'text/plain'});
response.end('Post action was requested');
}

function handlePutRequest(response) {
response.writeHead(200, {'Content-Type&apos...

Modularizing code

What we have developed so far is a simple HTTP server application that listens and processes known request types; however, it is not so well structured, as the functions handling the requests are not reusable. Node.js supports modules embracing code isolation and reusability.

A user-defined module is a logical unit consisting of one or more related functions. The module can export one or more functions to other components while keeping other functions visible only to itself.

We will rework our HTTP server application in such a way that the entire request handling functionality will be wrapped in a module. The module will export only a generic handler function that will take a request object as argument and, based on its request type, it will delegate the handling to inner functions not visible outside the module.

Let's start by creating a new module directory...

Testing Node.js

Now we will extend our project by providing a unit test for the HTTP module, but before diving into that, let's have a look at how Node.js supports unit testing in general. At the beginning of this chapter, we installed the Nodeunit module. Well, it's about time we started playing around with it.

First, let's create another simple Node.js module that we will use to implement our first unit test. Then we will move to more advanced topics, such as mocking JavaScript objects and using them to create unit tests for our HTTP module.

I have chosen to develop a simple math module that exports functions for adding and subtracting integer numbers, as it is straightforward enough and the results of each operation are strictly defined.

Let's start with the module and create the following math.js file in our module directory:

exports.add = function...

Deploying an application

Node.js has an event-driven, non-blocking I/O model, which makes it perfect for real-time applications that scale well in distributed environments, such as public or private cloud platforms. Each cloud platform offers tools that allow seamless deployment, distribution, and scaling of its hosted applications. In this section, we will look at two publicly available Node.js application cloud providers—Nodejitsu and Microsoft Azure.

But first, let's spend some time on the clustering support, as it is fundamental for understanding why Node.js fits so well into the cloud environment. Node.js comes with clustering support built in to its core. Using the cluster module in your applications allows them to start as many workers as necessary to handle the load they will face. Generally, it is recommended to match the number of workers to the number of...

Installing Node.js


Let's start our journey through Node.js with a Node.js installation. Installers are available for both Windows and macOS at https://nodejs.org/en/download/.  At the time of writing, Node.js 10 has just been released as the current version, and is about to become the next Long Term Support version, in August 2018. Linux users can either build Node.js from the available Linux binaries or make use of their package manager, as Node.js is available with most of the popular package repositories for different Linux distributions. For instance, Ubuntu and other Debian-based distributions should first point to the latest Node.js 10 package and then install via the apt-get command from the shell:

curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install nodejs

If you decide to go with an installer available for macOS or Windows, a wizard will guide you through a rather typical installation procedure, where you will have to accept the Node.js license agreement...

Installing the Express framework and other modules


Now that we have npm installed, let's make use of it and install some of the modules we will be using heavily throughout this book. The most important among them is the Express framework (http://www.expressjs.com/). It is a flexible web application framework for Node.js, providing a robust RESTful API for developing single or multi-page web applications. The following command will download the Express module from the npm repository and make it available for our local Node.js installation:

npm install -g express

You will find the express module among the results of an npm ls after a successful installation. Later in this chapter, we will learn how to write unit tests for our Node.js modules. We will need the nodeunit module for that purpose:

npm install nodeunit -g

The -g option will install nodeunit globally. This means that the module will be stored at a central place on your filesystem; usually, that is either /usr/lib/node_modules  or /usr...

Left arrow icon Right arrow icon
Download code icon Download Code

Key benefits

  • •Create rich and scalable RESTful API solutions from scratch
  • •Explore the new features of Node.js 10, Express 4.0, and MongoDB
  • •Integrate MongoDB in your Node.js application to store and secure your data

Description

When building RESTful services, it is really important to choose the right framework. Node.js, with its asynchronous, event-driven architecture, is exactly the right choice for building RESTful APIs. This third edition of RESTful Web API Design with Node.js 10 will teach you to create scalable and rich RESTful applications based on the Node.js platform. You will be introduced to the latest NPM package handler and understand how to use it to customize your RESTful development process. You will begin by understanding the key principle that makes an HTTP application a RESTful-enabled application. After writing a simple HTTP request handler, you will create and test Node.js modules using automated tests and mock objects; explore using the NoSQL database, MongoDB, to store data; and get to grips with using self-descriptive URLs. You’ll learn to set accurate HTTP status codes along with understanding how to keep your applications backward-compatible. Also, while implementing a full-fledged RESTful service, you will use Swagger to document the API and implement automation tests for a REST-enabled endpoint with Mocha. Lastly, you will explore some authentication techniques to secure your application.

Who is this book for?

If you are a web developer keen to enrich your development skills to create server-side RESTful applications based on the Node.js platform, this book is for you. Some knowledge of REST would be an added advantage, but is definitely not a necessity.

What you will learn

  • • Install, develop, and test your own Node.js user modules
  • •Understand the differences between HTTP and RESTful applications
  • •Use self-descriptive URLs and set accurate HTTP status codes
  • •Eliminate third-party dependencies in your tests with mocking
  • •Implement automation tests for a REST-enabled endpoint with Mocha
  • •Secure your services with NoSQL database integration within Node.js applications
  • • Integrate a simple frontend using JavaScript libraries available on a CDN server

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Apr 30, 2018
Length: 178 pages
Edition : 3rd
Language : English
ISBN-13 : 9781788623322
Languages :
Concepts :
Tools :

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing

Product Details

Publication date : Apr 30, 2018
Length: 178 pages
Edition : 3rd
Language : English
ISBN-13 : 9781788623322
Languages :
Concepts :
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
$19.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
$199.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts
$279.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total $ 125.97
Node.js Web Development
$48.99
RESTful Web API Design with Node.js 10, Third Edition
$32.99
Advanced Node.js Development
$43.99
Total $ 125.97 Stars icon
Banner background image

Table of Contents

10 Chapters
REST – What You Did Not Know Chevron down icon Chevron up icon
Getting Started with Node.js Chevron down icon Chevron up icon
Building a Typical Web API Chevron down icon Chevron up icon
Using NoSQL Databases Chevron down icon Chevron up icon
Restful API Design Guidelines Chevron down icon Chevron up icon
Implementing a Full Fledged RESTful Service Chevron down icon Chevron up icon
Preparing a RESTful API for Production Chevron down icon Chevron up icon
Consuming a RESTful API Chevron down icon Chevron up icon
Securing the Application Chevron down icon Chevron up icon
Other Books You May Enjoy Chevron down icon Chevron up icon

Customer reviews

Rating distribution
Full star icon Full star icon Full star icon Half star icon Empty star icon 3.5
(4 Ratings)
5 star 25%
4 star 50%
3 star 0%
2 star 0%
1 star 25%
Aparatologia ANAD SA de CV Aug 17, 2018
Full star icon Full star icon Full star icon Full star icon Full star icon 5
I was looking into something that will explain RESTful APIs in Nodejs, and he does a good job, explaning a lot of thing, in some places needs a little more detail, but you can find it on the web... I thought it was lacking code, the only thing I did not know was you need to call "express start" not "node app.js" and you may think that there are some missing parts on it, like having express listen....
Amazon Verified review Amazon
Carlos I. Martinez Aug 09, 2018
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
Overall I think it's a really good book if you want to understand the basics and a bit more on how REST API are created and how can be maintain. To get the most of this book the reader should code along the book to know how things works.Pro.- Very accurate concepts- It resumes very well the needed http status code- Very straightforward.Cont.- Some parts the author didn't mentioned where the user should write the code- In the MongoDB part there are some missing parts that should be added in order to make express connect to the database that the writer forgot to mention. Ex:In the connection part the port of the localhost can't be omitted for the server to connect to the dbThis is how it worked for me: `mongoose.connect('mongodb://localhost:27017/catalog', { useNewUrlParser: true })`Note:Page 133. Where the reader is asked to add a new item to the catalog via the POST method, in the data property the JSON object doesn't need the Stringify function.
Amazon Verified review Amazon
Vikas Aug 08, 2019
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
Good introduction but lacking on mongoose concepts e.g. async part of mongoose and how to handle it is missing
Amazon Verified review Amazon
GH Jan 31, 2019
Full star icon Empty star icon Empty star icon Empty star icon Empty star icon 1
Impossible to follow along, because important instructions about where to write the code and what commands to run are missing.
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is included in a Packt subscription? Chevron down icon Chevron up icon

A subscription provides you with full access to view all Packt and licnesed content online, this includes exclusive access to Early Access titles. Depending on the tier chosen you can also earn credits and discounts to use for owning content

How can I cancel my subscription? Chevron down icon Chevron up icon

To cancel your subscription with us simply go to the account page - found in the top right of the page or at https://subscription.packtpub.com/my-account/subscription - From here you will see the ‘cancel subscription’ button in the grey box with your subscription information in.

What are credits? Chevron down icon Chevron up icon

Credits can be earned from reading 40 section of any title within the payment cycle - a month starting from the day of subscription payment. You also earn a Credit every month if you subscribe to our annual or 18 month plans. Credits can be used to buy books DRM free, the same way that you would pay for a book. Your credits can be found in the subscription homepage - subscription.packtpub.com - clicking on ‘the my’ library dropdown and selecting ‘credits’.

What happens if an Early Access Course is cancelled? Chevron down icon Chevron up icon

Projects are rarely cancelled, but sometimes it's unavoidable. If an Early Access course is cancelled or excessively delayed, you can exchange your purchase for another course. For further details, please contact us here.

Where can I send feedback about an Early Access title? Chevron down icon Chevron up icon

If you have any feedback about the product you're reading, or Early Access in general, then please fill out a contact form here and we'll make sure the feedback gets to the right team. 

Can I download the code files for Early Access titles? Chevron down icon Chevron up icon

We try to ensure that all books in Early Access have code available to use, download, and fork on GitHub. This helps us be more agile in the development of the book, and helps keep the often changing code base of new versions and new technologies as up to date as possible. Unfortunately, however, there will be rare cases when it is not possible for us to have downloadable code samples available until publication.

When we publish the book, the code files will also be available to download from the Packt website.

How accurate is the publication date? Chevron down icon Chevron up icon

The publication date is as accurate as we can be at any point in the project. Unfortunately, delays can happen. Often those delays are out of our control, such as changes to the technology code base or delays in the tech release. We do our best to give you an accurate estimate of the publication date at any given time, and as more chapters are delivered, the more accurate the delivery date will become.

How will I know when new chapters are ready? Chevron down icon Chevron up icon

We'll let you know every time there has been an update to a course that you've bought in Early Access. You'll get an email to let you know there has been a new chapter, or a change to a previous chapter. The new chapters are automatically added to your account, so you can also check back there any time you're ready and download or read them online.

I am a Packt subscriber, do I get Early Access? Chevron down icon Chevron up icon

Yes, all Early Access content is fully available through your subscription. You will need to have a paid for or active trial subscription in order to access all titles.

How is Early Access delivered? Chevron down icon Chevron up icon

Early Access is currently only available as a PDF or through our online reader. As we make changes or add new chapters, the files in your Packt account will be updated so you can download them again or view them online immediately.

How do I buy Early Access content? Chevron down icon Chevron up icon

Early Access is a way of us getting our content to you quicker, but the method of buying the Early Access course is still the same. Just find the course you want to buy, go through the check-out steps, and you’ll get a confirmation email from us with information and a link to the relevant Early Access courses.

What is Early Access? Chevron down icon Chevron up icon

Keeping up to date with the latest technology is difficult; new versions, new frameworks, new techniques. This feature gives you a head-start to our content, as it's being created. With Early Access you'll receive each chapter as it's written, and get regular updates throughout the product's development, as well as the final course as soon as it's ready.We created Early Access as a means of giving you the information you need, as soon as it's available. As we go through the process of developing a course, 99% of it can be ready but we can't publish until that last 1% falls in to place. Early Access helps to unlock the potential of our content early, to help you start your learning when you need it most. You not only get access to every chapter as it's delivered, edited, and updated, but you'll also get the finalized, DRM-free product to download in any format you want when it's published. As a member of Packt, you'll also be eligible for our exclusive offers, including a free course every day, and discounts on new and popular titles.