Skip to content

A sample REST service with the Spark web framework

Notifications You must be signed in to change notification settings

reti2vc-2018/spark-rest

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

REST Server for Tasks

A simple REST server for introducing REST concepts with the Spark web framework in Java. Dependencies are handled with gradle.

It provides basic support for showing and creating tasks (i.e., description and task urgency).

API


Resource: tasks

Url: /api/v1.0/tasks

Description: The tasks currently available on the server, without paging

Method: GET - Retrieve the list of available tasks

Example Response:

{
  "tasks": [
    {
      "description": "call John for IoT project organization",
      "id": 22,
      "urgent": 1
    },
    {
      "description": "buy a new mouse",
      "id": 23,
      "urgent": 1
    },
    {
      "description": "find a present for Angelina's birthday",
      "id": 24,
      "urgent": 0
    }
...
}

Method: POST - Create a new task

Parameters: description, urgent

Example:

{
	"description" : "This is a new task",
	"urgent" : 0
}

Url: /api/v1.0/tasks/:task_id

Method: GET - Retrieve the task identified by the given task_id (an integer number)

Example Response:

{
  "task": {
    "description": "call Giovanni for AmI project organization",
    "id": 22,
    "urgent": 1
  }
}