Giter VIP home page Giter VIP logo

todo's Introduction

Todo API

To utilize the API, data will either need to be sent or received in a JSON format that's an array with objects that have fields for id, value, and, checked and some of those fields will be required depending on the API call.

To use this service:

  1. Make sure no service is hosting on port 80
  2. Git clone this project
  3. In the project folder run 'docker-compose up'
  4. Wait a minute or two till you see the MySQL message 'mysqld: ready for connections.'

API Calls

  • Create Todos (createTodos) - will create new todo item entries, each entry will need a value field provided. Values do not have to be unique

      curl -X POST -d '[{"value": "do 20 pushups"}, {"value": "floss teeth"}, {"value": "do 20 pushups"}]' http://localhost/createTodos
    
  • Get All Todos (getAllTodos) - will retrieve all todo items (value, checked status, id) whether they are checked or not

       curl -X GET http://localhost/getAllTodos
    
  • Check Off Todos (checkTodos) - will check off todo items based on id

      curl -X POST -d '[{"id": 2}, {"id": 3}]' http://localhost/checkTodos
    
  • Uncheck Todos (uncheckTodos) - will uncheck todo items based on id

      curl -X POST -d '[{"id": 3}]' http://localhost/uncheckTodos
    
  • Get Open Todos (getOpenTodos) - will retrieve only open or unchecked todo items (value, checked status, id)

      curl -X GET http://localhost/getOpenTodos
    

todo's People

Contributors

tinnyatpardot avatar

Watchers

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