Skip to content

FeliLan/todolist_mock_server

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

To Do List Server Mock

Mock server for automation job candidates.

  • Server implements RESTful API
  • All API responses are formatted in JSON
  • The server will be answering to requests on port 5000 (http://localhost:5000)

HTTP status codes

If you're unfamiliar with the HTTP status code, you may find this information useful: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes

Environment Prerequisites

Installation

As best practice (not mandatory), we recommend installing virtualenv and virtualenvwrapper.

Then, to install project prerequisites, inside the project root, run:

pip install .

Run the server mock

Windows

C:\path\to\app>set FLASK_APP=server.py
C:\path\to\app>flask run

Linux

export FLASK_APP=server.py
flask run

Authentication

Authentication is not required.

API Endpoints

Following is the complete list of endpoints to work against.

Listing tasks

Description: Listing tasks
Usage: GET /tasks
Produces: application/json

Sample response:

{}

Get task

Description: Get a single task
Usage: GET /tasks/<task_id>
Produces: application/json

parameters
  • <task_id>: task id. Can be retrieved when creating a new task, or when listing all tasks.

Sample response:

{
  "task": "add task",
  "completed": false
}

Create task

Description: Create a task
Usage: POST /tasks/<task_id> Produces: application/json

parameters
  • <task_id>: task id. Can be retrieved when creating a new task, or when listing all tasks.
request body

JSON formatted object with attributes:

  • task: task title
  • completed: (boolean) whether task is completed

Sample request:

{
  "task": "add task",
  "completed": false
}

Sample response:

{
  "task_id": "1234",
}

Modify task

Description: Modifies an existing task
Usage: PUT /tasks/<task_id>
Produces: application/json

parameters
  • <task_id>: task id. Can be retrieved when creating a new task, or when listing all tasks.

Sample request:

{
  "task": "add task",
  "completed": false
}

Sample response:

{
  "task_id": "1234",
}

Mark task completed

Description: Mark an existing task as completed
Usage: POST /tasks/<task_id>/completed
Produces: application/json

parameters
  • <task_id>: task id. Can be retrieved when creating a new task, or when listing all tasks.

Sample response:

{}

Mark task incomplete

Description: Mark an existing task as incomplete
Usage: POST /tasks/<task_id>/incomplete
Produces: application/json

parameters
  • <task_id>: task id. Can be retrieved when creating a new task, or when listing all tasks.

Sample response:

{}

Delete a task

Description: Delete an existing task
Usage: DELETE /tasks/<task_id>
Produces: application/json

parameters
  • <task_id>: task id. Can be retrieved when creating a new task, or when listing all tasks.

Sample response:

{}

About

Mock server for automation job candidates.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%