Giter VIP home page Giter VIP logo

restify-api-basics's Introduction

RESTify API Basics

A simple API developed using the restify package to gain a basic insight of the how the package works.

Prerequisites

To run the API, install the following:

  • node.js v10.x or above
  • npm v6.x or above
  • curl v7.x or above

To manage multiple NodeJs versions, its recommended to use Node Version Manager.

Try It Out

To run the server:

  • Install required packages

    npm install
  • Initiate the server

    npm start

To test the various routes:

  • Add products to the store

    curl -H "Content-Type: application/json" -X POST -d '{"id":101,"name":"Pizza"}' http://127.0.0.1:3000/api/products
  • Fetch details for all products

    curl --request GET http://127.0.0.1:3000/api/products/
  • Update a product in the store

    curl -H "Content-Type: application/json" -X PUT -d '{"name":"Sandwich"}' http://127.0.0.1:3000/api/products/101
  • Fetch details for a product

    curl --request GET http://127.0.0.1:3000/api/products/101
  • Delete a product

    curl --request DELETE http://127.0.0.1:3000/api/products/101

To use Postman, remember to set the Content-Type header to application/json and pass the data as raw JSON under the Body tab.

restify-api-basics's People

Contributors

saraansh avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.