go-rest

Layered Architecture

APIs

Create a new TODO

API: localhost:8080/api/v1/todo
Method: POST
Payload:

{
    "value": "Todo Number one"
}

Response:

{
    "msg": "TODO created successfully"
}

List TODOs

PART-1

API: localhost:8080/api/v1/todo
Method: GET
Description: When page and limit is not passed then this API will take page = 0 and limit = 10 as default.
Response:

{
    "records": [
        {
            "id": "1",
            "value": "Todo Number one"
        },
        {
            "id": "2",
            "value": "Todo Number two"
        },
        {
            "id": "3",
            "value": "Todo Number three"
        },
        {
            "id": "4",
            "value": "Todo Number four"
        },
        {
            "id": "5",
            "value": "Todo Number five"
        },
        {
            "id": "6",
            "value": "Todo Number six"
        }
    ],
    "page": 0,
    "limit": 10,
    "count": 6,
    "total_count": 6,
    "total_pages": 0
}

PART-2

API: localhost:8080/api/v1/todo?page=0
Method: GET
Description: API page starts with 0. If there is only one page then we need to pass 0 as first page.
Response:

{
    "records": [
        {
            "id": "1",
            "value": "Todo Number one"
        },
        {
            "id": "2",
            "value": "Todo Number two"
        },
        {
            "id": "3",
            "value": "Todo Number three"
        },
        {
            "id": "4",
            "value": "Todo Number four"
        },
        {
            "id": "5",
            "value": "Todo Number five"
        },
        {
            "id": "6",
            "value": "Todo Number six"
        },
        {
            "id": "7",
            "value": "Todo Number 7"
        },
        {
            "id": "8",
            "value": "Todo Number 8"
        },
        {
            "id": "9",
            "value": "Todo Number 9"
        },
        {
            "id": "10",
            "value": "Todo Number 10"
        }
    ],
    "page": 0,
    "limit": 10,
    "count": 10,
    "total_count": 12,
    "total_pages": 1
}

PART-3

API: localhost:8080/api/v1/todo?page=2&limit=3
Method: GET
Response:

{
    "records": [
        {
            "id": "7",
            "value": "Todo Number 7"
        },
        {
            "id": "8",
            "value": "Todo Number 8"
        },
        {
            "id": "9",
            "value": "Todo Number 9"
        }
    ],
    "page": 2,
    "limit": 3,
    "count": 3,
    "total_count": 12,
    "total_pages": 4
}

Get TODO by ID

PART-1

API response when provided todo id exists in database.
API: localhost:8080/api/v1/todo/2
Method: GET
Response:

{
    "id": "2",
    "value": "Todo Number one"
}

PART-2

API response when provided todo id does not exist in database.
API: localhost:8080/api/v1/todo/2
Method: GET
Response:

Record not found with given ID=20

Delete TODO by ID

PART-1

API response when provided todo id exists in database.
API: localhost:8080/api/v1/todo/2
Method: DELETE
Response:

{
    "msg": "TODO deleted successfully"
}

PART-2

API response when provided todo id does not exist in database.
API: localhost:8080/api/v1/todo/2
Method: GET
Response:

Record not found with given ID=20

Update TODO by ID

PART-1

API response when provided todo id exists in database.
API: localhost:8080/api/v1/todo/2
Method: PUT
Response:

{
    "msg": "TODO updated successfully"
}

PART-2

API response when provided todo id does not exist in database.
API: localhost:8080/api/v1/todo/2
Method: PUT
Response:

Record not found with given ID=20