Git Product home page Git Product logo

todo's Introduction

API service for a TODO app

APIs

The TODO application has the following APIs to create and manipulate tasks

ListAll

Lists all tasks

GET http://localhost:8080/tasks

URI parameters:

Name In Required Type Description
sortBy Query False String Field to sort by
orderBy Query False String Order to sort by - can take the values asc or desc
outdatedOnly Query False Boolean Lists outdated tasks
priority Query False Integer Priority to filter by

Example:

GET http://localhost:8080/tasks?sortBy=dueDate&orderBy=desc&priority=3&outdatedOnly=true

FindById

Finds a task, identified by the id field

GET http://localhost:8080/tasks/{id}

URI parameters:

Name In Required Type Description
id Path True Long Id of task to find

Example:

GET http://localhost:8080/tasks/5

AddTask

Adds a task

POST http://localhost:8080/tasks

URI parameters:

None

Request Body:

Name Required MediaType Description
requestBody True JSON Task to add in JSON \ Other conditions:
  • Priority should be included
  • Id should not be included

Example:

POST http://localhost:8080/tasks

Request Body:

{
	"title": "Simple task 2",
	"priority": 4
}

UpdateTask

Updates a task, identified by the id field

PATCH http://localhost:8080/tasks/{id}

URI parameters:

Name In Required Type Description
id Path True Long Id of task to update

Request Body:

Name Required MediaType Description
requestBody True JSON Task to update in JSON \ Other conditions:
  • Id should not be included

Example:

PATCH http://localhost:8080/tasks/3

Request Body:

{
	"title": "Updated task",
	"priority": 4,
	"status": "Done"
}

References

todo's People

Contributors

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