Code Monkey home page Code Monkey logo

radiopy's Introduction

Sample rest API

A rest API allowing to post devices, set their location and get the location of a device. Implemented in python 3.8 using flask and sqlAlchemy with sqlite.

Build

Steps to run the project:

  1. Pull the repository git clone https://github.com/Johanpdrsn/RadioPy.git
  2. Navigate to directory
  3. Build docker image docker build --rm --pull -f "./Dockerfile" -t "radiopy:latest" .
  4. Run the container docker run --rm -d -p 5000:5000/tcp radiopy:latest

Test

Example use of the api:

  1. Add device http://localhost:5000/radios/100 POST with payload

    {
    "alias": "Radio100",
    "allowed_locations": ["CPH-1", "CPH-2"]
    }

    This will return 201 CREATED and the added device.

  2. Set location http://localhost:5000/radios/100/location POST with payload

    {
    "location": "CPH-1"
    }

    Returns 200 OK.

  3. Get location http://localhost:5000/radios/100/location GET. Returns 200 OK and the location.

radiopy's People

Contributors

johanpdrsn 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.