Git Product home page Git Product logo

saltside-bird's Introduction

saltside-bird

This is a REST API developed using MEAN stack. The dependencies are Express JS and Mongoose. The DB used here is MongoDB and the 'test' database is used for all crud operations.

Pre-requisites to be installed before running this API:

  1. NodeJS
  2. Mongo DB
  3. Postman (Chrome plugin) or any rest client to test the API

Steps to test the API:

a. Clone this repo to a local machine directory and from the root directory, do an "npm install" command which installs all dependencies.
b. Start the local mongodb instance and check if mongodb is running on 27017.
c. Navigate to the project root directory and you must see a server.js file which is the entry point file.
d. Launch the REST API server with the command "node server.js". By default ,this is started on port 8080.
e. From here on ,the below rest apis can be tested.

REST calls tested:

i) http://localhost:8080/birds - GET call - should get all the visible birds.
ii) http://localhost:8080/birds - POST call - should create the bird record in the mongo db or return 400 [with some custom error message] if validation fails in the request body
iii) http://localhost:8080/birds/{id} - GET call - should return the bird by id or return 404 error code if record does not exist
iv) http://localhost:8080/birds/{id} - DELETE call - should delete the record by id or return 404 error code if record does not exist

I have used chrome plugin POSTMAN plugin as the client to test the rest apis.

saltside-bird's People

Contributors

bharanic4040 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.