Git Product home page Git Product logo

rest-api-for-shop-app's Introduction

This is Express Server REST API for a Shop app

Hi, This is a simple json db API for a shop app. You can use this API for testing purpose. Here is using Node & Express Server and using json database system for all data.

Git Clone

$ git clone https://github.com/shb-services/REST-API-for-shop-app.git

Frameworks

  • Node js
  • Express js

Packages Installation

  • nodemon
  • dotenv
  • express
  • colors
$ npm i packages_name

List of API's

Import Postman Collection Documetation

Copy below link or

https://documenter.getpostman.com/view/22686421/2s83zfS6Rh

Use API

In this below console, there is showing "desc, name and access".

  • desc
    • "desc" is to describe details.
  • name
    • "name" is Method & API link.
  • access
    • "access" is who can access this system.
S. Note : use your domain before /api/v1/slug

User API Documentation


Create User Data - API

/**
 * desc Create a user data
 * name POST /api/v1/user
 * access public
 */

// need keys to create a user   

    name : "Name",
    email : "Email", 
    cell : "Cell",
    location : "Location",
    zip_code : "Zip Code",
    shipping_address : "Shipping Address",
    billing_address : "Billing Address"

Create Product Data - API

/**
 * desc Create a product data
 * name POST /api/v1/product
 * access public
 */

// need keys to create a product   

    name : "Name",
    slug : "Slug", 
    regular_price : "Regular Price",
    sale_price : "Sale Price",
    stock : "Stock",
    short_desc : "Short Description",
    long_desc : "Long Description",
    category : "Category",
    tag : : "Tag"

Create Category Data - API

/**
 * desc Create a category data
 * name POST /api/v1/category
 * access public
 */

// need keys to create a category   

    name : "Name",
    slug : "Slug", 
    photo : "Photo"

Create Tag Data - API

/**
 * desc Create a tag data
 * name POST /api/v1/tag
 * access public
 */

// need keys to create a tag   

    name : "Name",
    slug : "Slug",

rest-api-for-shop-app's People

Contributors

dev-sahab avatar

Watchers

 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.