node-express-server-rest-api icon indicating copy to clipboard operation
node-express-server-rest-api copied to clipboard

Basic Node with Express Server with REST API

Simple Node with Express Server with REST API

Build Status Slack Greenkeeper badge

An easy way to get started with a Express server offering a REST API with Node.js. Read more about it.

Features

  • Express
  • REST API

Requirements

Installation

  • git clone [email protected]:rwieruch/node-express-server-rest-api.git
  • cd node-express-server-rest-api
  • npm install
  • npm start
  • optional: include .env in your .gitignore

GET Routes

  • visit http://localhost:3000
    • /messages
    • /messages/1
    • /users
    • /users/1

Beyond GET Routes

CURL

  • Create a message with:
    • curl -X POST -H "Content-Type:application/json" http://localhost:3000/messages -d '{"text":"Hi again, World"}'
  • Delete a message with:
    • curl -X DELETE -H "Content-Type:application/json" http://localhost:3000/messages/1

Postman

  • Install Postman to interact with REST API
  • Create a message with:
    • URL: http://localhost:3000/messages
    • Method: POST
    • Body: raw + JSON (application/json)
    • Body Content: { "text": "Hi again, World" }
  • Delete a message with:
    • URL: http://localhost:3000/messages/1
    • Method: DELETE