Git Product home page Git Product logo

amp-todos's Introduction

TODO Tool - A RESTful API

Notes

I've only implemented the features specifically outlined in the requirements. There are more features which could be added that are likely needed by the scenario (ability to unsubscribe from todos, deleting todos, authorisation in request headers, etc) but have been omitted due to time constraints.

Assumptions

  • PHP7 + MySQLi extension.
  • Access to the API is controlled outside of the tool.
  • The server the tool runs on is configured for sending e-mails through the PHP mail function.
  • A MySQL database exists with details that match with the db.ini file.
  • In said MySQL database the following three table should exist:
  • The users table is populated external to the tool.
  • The example request URIs below assume the API is run on the localhost under a todos directory.

Requests

Get Undone Todos

GET | http://localhost/todos/ListIncompleteTodos.php

Create Todo

POST | http://localhost/todos/CreateTodo.php

{ 
  "description": "Buy milk"
}

Complete Todo

PUT | http://localhost/todos/CompleteTodo.php

{ 
  "todo_id": 3
}

Subscribe

POST | http://localhost/todos/SubscribeToTodo.php

{ 
 "user_id": 1,
 "todo_id": 2
}

amp-todos's People

Contributors

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