Code Monkey home page Code Monkey logo

amazon-review-api's Introduction

Amazon Review API

The purpose of this API is to process Amazon reviews in order to provide useful statistics, such as the best rated product in a given time range.

Screenshot 2023-03-05 at 21 05 27

As can be seen in the image above, this API has a dependency on the persistence microservice so please ensure to have both running locally.

Prerequisites

  • SBT
  • Java 11+
  • Mongo 3.6+

Build and run

This service runs on port 8081. You can compile and run it with the following command sbt compile run

Testing

  • To run unit tests use sbt test
  • To run integration tests use sbt it:test

Libraries

  • http4s: Automatically streams requests using fs2
  • fs2: Functional streaming
  • Guava: Performance improvement for computationally intensive queries
  • Circe: JSON library
  • Logback: Logging requests

Requests

POST /amazon/best-rated HTTP/1.1
Host: localhost:8080
Content-Type: application/json

{
  "start": "01.01.2010",
  "end": "31.12.2020",
  "limit": 2,
  "min_number_reviews": 2
}

Note: This request is validated in the API.

Response:

  • 200: Successful response with a response in the following json format:
[
  {
    "asin": "B000JQ0JNS",
    "average_rating": 4.5
  },
  {
    "asin": "B000NI7RW8",
    "average_rating": 3.666666666666666666666666666666667
  }
]
  • 400: Bad request with the problem stated in the body
  • 500: Internal server error

amazon-review-api's People

Contributors

liandra-giacomine 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.