thisham / motostock-api Goto Github PK

Overview

The transaction feature was used as input the stock of vehicles. The feature will affect these endpoints:

• POST /transaction/in/motor
• POST /transaction/in/car

Structure

Motor

Input:

• Production Year : integer
• Color : string
• Price : float
• Machine : string
• Suspension Type : string
• Transmission Type : string

Output (expected):

• id : string // use uuid v4

Car

Input:

• Production Year : integer
• Color : string
• Price : float
• Machine : string
• Passenger Capacity : integer
• Type : string

Output (expected):

• id : string // use uuid v4

Overview

As known as the selling step. These endpoints will be affected:

• POST /transaction/out/:vehicle-id

Overview

Create a report which contains selling total, selling revenue. These endpoint will be affected:

• GET /report

Expectation

Output:

{
  "sold": 0000,
  "total_revenue": 0000.00,
  "car_selling": {
    "sold": 0000,
    "revenue": 0000.00
  },
  "motor_selling": {
    "sold": 0000,
    "revenue": 0000.00
  }
}

Overview

After input flow in transaction, the stock must be able to be checked. This issue will affect these endpoints:

• GET /stock
  This endpoint will be used to count and present the current value of car and motor. Expected output:

  • Motor : integer
  • Car : integer

• GET /stock/motor
  This endpoint simply view all data of the stock of motor. Expected output:

  • Data : []Motor

• GET /stock/car
  This endpoint simply view all data of the stock of car. Expected output:

  • Data : []Car

• GET /stock/:id
  This endpoint simply show the selected data of a vehicle. Expected output:

  • Data : Car / Motor

Overview

The ideal project must has an proper documentation, such as:

• API Spec;
• Basic specification; and
• Installation guides.

Even on going project is on going, at least, a minimum API Spec must be created.