todos

la référence de l'endpoint todos

obtenir toute les todos

GET /api/todos/all

obtient toute les todos

Query Parameters

Name	Type	Description
limit	String	limite de la taille de la réponse(défauts: 30)
page	String	paginations(défauts: 1) note: paginations en fonction de la limite de la taille de la réponse

200: OK toute les todos ont été récupérer

{
    "todos": [
        {
            "name": "todo 3",
            "completed": false,
            "id": "b60853c2-eae4-48bc-9b64-4bfd68e4c1a4"
        },
        {
            "name": "todo 2",
            "completed": false,
            "id": "15aa84d3-c56d-40d9-b5f2-d2f344347320"
        },
        {
            "name": "todo 1",
            "completed": true,
            "id": "d21d02c1-c72e-4b59-8bd6-bf8321bbfee2"
        }
    ],
    "limit": 30,
    "page": 1
}

obtenir une todo par son id

GET /api/todos/get

obtient une todo par son id

Query Parameters

Name	Type	Description
id*	String	id de la todo à récupéré

200: OK la todo à bien été récupéré

{
    "name": "todo 1",
    "completed": true,
    "id": "d21d02c1-c72e-4b59-8bd6-bf8321bbfee2"
}

404: Not Found la todo n' pas été trouvée

{
    "error": true,
    "message": "todo not found"
}

400: Bad Request la requête est mal formé

{
    "error": true,
    "message": "request malformed"
}

créer une nouvelle todo

POST /api/todos/create

crée une nouvelle todo

Request Body

Name	Type	Description
name*	String	nom de la todo

201: Created la todo à bien été crée

{
    // Response
}

409: Conflict la todo existe déjà

{
    "error": true,
    "message": "todo already exist"
}

400: Bad Request la requête est mal formée

{
    "error": true,
    "message": "request malformed"
}

supprimer une todo

DELETE /api/todos/delete

supprimé une todo

Query Parameters

Name	Type	Description
id*	String	id de la todo à supprimé

400: Bad Request requête mal formé

{
    "error": true,
    "message": "request malformed"
}

204: No Content la todo à bien été supprimé

modifier une todo

PUT /api/todos/put

modifié une todo avec son id

Query Parameters

Name	Type	Description
id*	String	id de la todo à modifier

Request Body

Name	Type	Description
completed*	Boolean	la todo est complete

200: OK la todo à bien été modifié

{
    "name": "todo 1",
    "completed": false,
    "id": "d21d02c1-c72e-4b59-8bd6-bf8321bbfee2"
}

400: Bad Request la requête à été malformée

{
    "error": true,
    "message": "todo not found"
}

404: Not Found la todo n'a pas été trouvé

{
    "error": true,
    "message": "todo not found"
}