Giter VIP home page Giter VIP logo

retail-store's Introduction

Retail-store

Please refer UML.png in the root directory for high level key classes relationships

Command to build the solution

./gradlew clean build

Command to run the application

java -jar <path_to>/retail-store-1.0.jar

Sample command to run application:

java -jar build/libs/retail-store-1.0.jar

Sample command to run tests:

./gradlew test

Test coverage report

Generate coverage report by executing tests using command : ./gradlew test

Test report path : build/reports/tests/test/index.html

Sample request and response

Request Body

{
  "totalAmount": 200,
  "isGroceries": false,
  "userType": "EMPLOYEE"
}

Response Body

{
    "netPayableAmount": 130.0
}

Input Description

totalAmount : double
isGroceries : Boolean
userType : Enum (EMPLOYEE, AFFILIATE, CUSTOMER_FOR_TWO_YEARS)

Sample curl command to hit API

curl --location --request POST 'localhost:8080/net-payable' \
--header 'Content-Type: application/json' \
--data-raw '{
  "totalAmount": 200,
  "isGroceries": false,
  "userType": "EMPLOYEE"
}'

To document the API, I would use a tool like Swagger or OpenAPI Specification (OAS) to provide a clear and structured documentation of the API endpoints, request parameters, response structures, and example usage.

POST /net-payable

{
    "totalAmount": 200,
    "isGroceries": false,
    "userType": "EMPLOYEE"
}


200 OK

{
    "netPayableAmount": 130.0
}

retail-store's People

Contributors

sunny-shaw 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.