Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osandadeshan/expressjs-restful-apis-demo
A sample project to demonstrate RESTful API development using Express.js
https://github.com/osandadeshan/expressjs-restful-apis-demo
api-development crud expressjs mongodb rest-services restapi
Last synced: about 2 months ago
JSON representation
A sample project to demonstrate RESTful API development using Express.js
- Host: GitHub
- URL: https://github.com/osandadeshan/expressjs-restful-apis-demo
- Owner: osandadeshan
- Created: 2019-07-22T08:46:12.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T23:14:18.000Z (about 2 years ago)
- Last Synced: 2023-02-27T12:16:58.278Z (almost 2 years ago)
- Topics: api-development, crud, expressjs, mongodb, rest-services, restapi
- Language: JavaScript
- Homepage:
- Size: 208 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RESTful API Development using Express.js
## What is REST?
**REST**, or Representational State Transfer, is an architectural style for providing standards between computer systems on the web, making it easier for systems to communicate with each other. REST-compliant systems, often called RESTful systems, are characterized by how they are stateless and separate the concerns of client and server. We will go into what these terms mean and why they are beneficial characteristics for services on the Web.
The REST architectural style describes six constraints that were originally communicated by Roy Fielding in his doctoral dissertation and defines the basis of RESTful-style as:
1. Uniform Interface
2. Stateless
3. Cacheable
4. Client-Server
5. Layered System
6. Code on Demand (optional)
RESTful services use HTTP requests to perform **CRUD (Create, Read, Update, Delete) operations**.
## What is Express.js?
Express is a fast, assertive, essential and moderate web framework of Node.js. You can assume express as a layer built on the top of the Node.js that helps manage a server and routes. It provides a robust set of features to develop web and mobile applications.
Let’s see some of the core features of Express framework
* It can be used to design single-page, multi-page and hybrid web applications.
* It allows to setup middleware to respond to HTTP Requests.
* It defines a routing table which is used to perform different actions based on HTTP method and URL.
* It allows to dynamically render HTML Pages based on passing arguments to templates.
## Express.js Architecture
## Advantages of Express.js?
* Ultra-fast I/O
* Asynchronous and single threaded
* MVC like structure
* Robust API makes routing easy
## Tools/Technologies
* Node.js
* MongoDB
* Text editor (Notepad++, Sublime, Atom, VSCode)
* Postman
## Pre-requisites
Node.js and MongoDB should be installed. If you haven’t installed them, you can install from the below URLs.
* [Node.js](https://nodejs.org/en/download/package-manager/)
* [MongoDB](https://docs.mongodb.com/manual/installation/)
## Getting started
Basically this project contains RESTful APIs for CRUD operations which developed using Mongoose and Express.js.
Open your terminal and follow the following steps.
1. Clone this project to your computer \
**`git clone https://github.com/osandadeshan/expressjs-restful-apis-demo.git`**
2. Navigate to the project folder \
**`cd expressjs-restful-apis-demo`**
3. Install the relevant node modules \
**`npm install`**
4. Start the server \
**`npm start`** \
Then you will see \
**RESTful API demo server started on: 3000**
## Testing via Postman
Now that everything is now connected, let’s test each of the routes and the respective methods.
Open your postman and type:
1. **http://localhost:3000/tasks** in the enter request URL section
2. Change the HTTP method to **POST** and select raw radio button
3. Then choose **JSON (application/json)**
4. Enter the body as follows
```json
{
"name": "Task 1",
"category": "R&D",
"status": "Completed",
"createdDate": "2019-07-11T04:06:44.110Z"
}
```
5. Click on Send button
6. It will give the response as **201 (Created)**
**POST Request**
7. You can try other HTTP methods such as GET, PUT and DELETE as well using [this postman collection](https://www.getpostman.com/collections/d9646cc382d69aca3111)
**GET Request**
**PUT Request**
**DELETE Request**
**Note**: Health route can be verified using **GET http://localhost:3000/health**
**Health Request**
