e-shop

la réference de l'endpoint shop

obtenir tout les articles

GET /api/shop/all

obtient tout les articles(avec ou sans pagination)

Query Parameters

Name	Type	Description
limit	String	limit d'article envoyer sur une page
page	String

200: OK les articles ont bien été transmis(sans paginations)

{
    "items": [
        {
            "name": "pull modifed *2",
            "amount": 0,
            "id": "8f9e5eb8-b5db-4f49-872b-590affda924f"
        }
    ]
}

200: OK avec la paginations

{
    "items": [
        {
            "name": "pull modifed *2",
            "amount": 0,
            "id": "8f9e5eb8-b5db-4f49-872b-590affda924f"
        }
    ],
    "limit": 4,
    "page": 1
}

acheter un produit

POST /api/shop/buy

achète un produit

Query Parameters

Name	Type	Description
id*	String	id du produit à acheter
amount*	String	quantiter à acheter

200: OK l'article à bien été acheter

{
    // Response
}

404: Not Found l'article n'a pas été trouver

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

409: Conflict la quantiter à acheter est supérieur au stock disponible

{
    "error": true,
    "message": "this item can't be buy"
}

400: Bad Request la requête est mal former

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

vendre un produit

POST /api/shop/sell

vend un produit

Query Parameters

Name	Type	Description
id*	String	id du produit à vendre
amount*	String	quantiter à vendre

200: OK l'article à bien été vendus

{
    // Response
}

404: Not Found l'article n'a pas été trouver

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

400: Bad Request la requête est mal former

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

supprimer un produit

DELETE /api/shop/delete

supprime un produit

Query Parameters

Name	Type	Description
id*	String	id du produit à supprimer

204: No Content l'article à bien été supprimer

{
    // Response
}

404: Not Found l'article n'a pas été trouver

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

400: Bad Request la requête est mal former

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

créer un produit

POST /api/shop/create

crée un produit

Request Body

Name	Type	Description
name*	String	nom du produit à crée
amount	number	quantiter du produit

201: Created l'article à bien été crée

{
    "name": "pull & bea",
    "amount": 5,
    "id": "1a32051c-cde1-44a8-924a-f871c62947d7"
}

400: Bad Request la requête est mal former

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

modifer un produit

PUT /api/shop/create

modifie un produit avec son nom ou sa quantiter et son id

Query Parameters

Name	Type	Description
id*	String	id du produit à modifier

Request Body

Name	Type	Description
name	String	nom du produit à crée
amount	number	quantiter du produit

200: OK l'article à bien été modifier

{
    "name": "pull modifed",
    "amount": 100,
    "id": "8f9e5eb8-b5db-4f49-872b-590affda924f"
}

400: Bad Request la requête est mal former

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

400: Bad Request la quantiter n'est pas un nombre

{
    "error": true,
    "message": "amount is not a number"
}