Giter Club home page Giter Club logo

country-filter's Introduction

Country filter API

A simple API for filtering countries from a dataset over an specific satisfaction index value.

Requirements

  • Docker
  • Python 3.8

Installation

Inside the root folder of the project, run the following command

> docker-compose build

Then start the project with the following command

> docker-compose up

Now, you should be able to test the endpoints.

Available API endponits:

Get API health

this endpoint allows you to check whether the API is running or not. If the API is running, you should receive a simple confirmation message.

http://localhost:5000/

Example response:

API is running

GET filtered countries

http://localhost:5000/country?satisfaction_index=100000

Example response with satisfaction_index 100000:

{
  "countries": [
    {
      "Country": "Belgium",
      "Flags": "",
      "Indicator": "Household net financial wealth",
      "Inequality": "Total",
      "Measure": "Value",
      "PowerCode": "Units",
      "Reference Period": "",
      "Unit": "US Dollar",
      "Value": 104084
    },
    {
      "Country": "Switzerland",
      "Flags": "",
      "Indicator": "Household net financial wealth",
      "Inequality": "Total",
      "Measure": "Value",
      "PowerCode": "Units",
      "Reference Period": "",
      "Unit": "US Dollar",
      "Value": 128415
    },
    {
      "Country": "United States",
      "Flags": "",
      "Indicator": "Household net financial wealth",
      "Inequality": "Total",
      "Measure": "Value",
      "PowerCode": "Units",
      "Reference Period": "",
      "Unit": "US Dollar",
      "Value": 176076
    }
  ]
}

Swagger endpoint

This endpoint allows anyone to visualize and interact with the API's resources.

http://localhost:5000/api/docs

ToDos

  • Write integration tests
  • Apply cache for the GET endpoint

country-filter's People

Contributors

exequielmoneva avatar dependabot[bot] 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.