https://github.com/9andresc/restful-web-api-design-with-node.js

My coding practices from the book: RESTful Web API Design with Node.js - Second Edition
https://github.com/9andresc/restful-web-api-design-with-node.js

Last synced: 2 months ago
JSON representation

My coding practices from the book: RESTful Web API Design with Node.js - Second Edition

• Host: GitHub
• URL: https://github.com/9andresc/restful-web-api-design-with-node.js
• Owner: 9andresc
• License: mit
• Created: 2016-09-10T00:46:27.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-09-13T13:17:04.000Z (over 8 years ago)
• Last Synced: 2025-02-04T16:50:18.624Z (4 months ago)
• Language: JavaScript
• Homepage: https://www.packtpub.com/web-development/restful-web-api-design-nodejs-second-edition
• Size: 34.2 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RESTful Web API Design with Node.js

My coding practices from the book: [RESTful Web API Design with Node.js - Second Edition](https://www.packtpub.com/web-development/restful-web-api-design-nodejs-second-edition)

## Chapter 1: What You Did Not Know

Key principles around the HTTP and URI standards:

- Everything is a resource

- Each resource is identifiable by an unique identifier (URI)

- Use the standard HTTP methods

- Resources can have multiple representations

- Communicate in a stateless way

The REST goals are:

- Separation of the representation and the resource

- Visibility

- Reliability

- Scalability

- Performance

## Chapter 2: Getting Started with Node.js

Steps to get started:

- Initialize `package.json` file with `npm init` command

- Install Express and other modules through NPM

- Setting up a development environment

Playing around with basic Node.js:

- Handling HTTP requests

- Modularizing code

- Testing Node.js

- Working with mock objects

## Chapter 3: Building a Typical Web API

To sum up, I will learn the following:

- How to specify a Web API

- How to implement routes

- How to query the API

- How content negotiation works

- What is CORS

- API versioning

## Chapter 4: Using NoSQL Databases

NoSQL databases are used heavily in cloud environments. They have the 

following advantages over traditional SQL databases:

- They are schemaless, that is, they work with object representations 

rather than store the object state in one or several tables, depending 

on their complexity.

- They are extendable, because they store an actual object. Data 

evolution is supported implicitly, so all you need to do is just call 

the operation that stores the object.

- They are designed to be highly distributed and scalable.

These are the NoSQL databases to review & use:

- LevelDB

- MongoDB

#### LevelDB

It is an open-source implementation developed by Google and written in 

C++. It is supported by a wide range of platforms, including Node.js. 

LevelDB is a key/value store; both the key and value are represented as 

binary data, so their content can vary from simple strings to binary 

representations of serialized objects in any format, such as JSON or 

XML.

What makes LevelDB perform better than an arbitrary file storage 

implementation is it uses a "log-structured merge" topology, which 

stores all write operations in an in-memory log, transferred (flushed) 

regularly to a permanent storage called Sorted String (SST) files. Read 

operations first attempt to retrieve entries from a cache containing 

the most commonly returned results. The size of the reading cache and 

the flush interval of the writing log are configurable parameters, 

which can be further adjusted in order to be adequate for the 

application load.

#### Key Difference Between Key/Value and Document Stores

Unlike a key/value store, document stores support indexing and 

searching for data based on different criteria, for example, attributes 

of a given document. This brings greater flexibility in comparision to 

key/value stores.

#### MongoDB

Is an open-source document database with built-in support for the JSON 

format. It provides a full index support, based on any of the available 

attributes in a document. It is ideal for high-availability scenarios 

due to its scalability features.

#### Mongoose

Is a module that connects Node.js to MongoDB ia an object document 

mapper (ODM) style. It offers the create, read, update and delete 

functionalities for documents stored in the database. Mongoose defines 

the structure of the used documents using schemas. The schema is 

smallest unit of data definition in Mongoose. A model is built out of a 

schema definition. It is a constructor-like function that can be used 

to create or query documents. Documents are instances of a model and 

represent one-to-one mapping to the documents stored in MongoDB. The 

schema-model-document hierarchy provides a self-descriptive way of 

defining objects and allows easy data validation.

## Chapter 5: Implementing a Fully-Fledged RESTful Service

To turn our mobile contacts data service into a fully-fledged RESTful 

service we need to look at these:

- Extensibility and versioning

- Working with arbitrary data

- Linking

- Paging and filtering

- Caching

- Discovery and exploration