Le CRUD

Les quatre fonctions de base que les modèles doivent pouvoir exécuter sont les suivantes : « créer », « lire », « mettre à jour » et « supprimer ». (CRUD).

Create, Read, Update, Delete

Lors de la conception d'API, nous voulons que nos modèles fournissent quatre types de fonctionnalités de base. Le modèle doit pouvoir créer, lire, mettre à jour et supprimer des ressources. Les informaticiens désignent souvent ces fonctions par l'acronyme CRUD. Pour être complet, un modèle doit pouvoir exécuter ces quatre fonctions. Si une action ne peut pas être décrite par l'une de ces quatre opérations, elle devrait potentiellement constituer un modèle à part entière.

Le paradigme CRUD est courant dans la conception d'applications Web, car il fournit un cadre mémorable qui aide les développeurs à créer des modèles complets et utilisables.

"book": {
    "id": "<Integer>",
    "title": "<String>",
    "author": "<String>",
    "isbn": "<Integer>"
}

• CREATE (créer) : ajouter un nouveau livre au catalogue avec un identifiant unique.
• READ (lecture) : afficher tous les livres ou un livre spécifique, sans modifier les données.
• UPDATE (Mise à jour) : modifier les informations d'un livre existant.
• DELETE (Supprimer) : supprimer un livre du catalogue.

CRUD et REST

Dans un environnement REST, les opérations CRUD correspondent souvent aux méthodes HTTP POST, GET, PUT et DELETE.

Create (créer)

Pour créer des ressources dans un environnement REST, nous utilisons le plus souvent la méthode HTTP POST.

Request:

POST http://www.myrestaurant.com/dishes/

Body:

{
    "dish": {
        "name": "Toast à l'avocat",
        "price": 8
    }
}

Response:

Status Code - 201 (CREATED)

{
    "dish": {
        "id": 1223,
        "name": "Toast à l'avocat",
        "price": 8
    }
}

Read (lire)

Pour lire des ressources dans un environnement REST, nous utilisons la méthode GET.

Request:

GET http://www.myrestaurant.com/dishes/1223

Response:

Status Code - 200 (OK)

{
    "id": 1223,
    "name": "Toast à l'avocat",
    "price": 8
}

Update (mise à jour)

PUT est la méthode HTTP utilisée pour l'opération CRUD Update.

Request:

PUT http://www.myrestaurant.com/dishes/1223

Body:

{
    "dish": {
        "name": "Toast à l'avocat",
        "price": 10
    }
}

Response:

Status Code - 200 (OK)

Delete (supprimer)

L'opération CRUD Delete correspond à la méthode HTTP DELETE.

Request:

DELETE http://www.myrestaurant.com/dishes/1223

Response:

Status Code - 204 (NO CONTENT)

Au fur et à mesure que vous vous exercerez à la conception de systèmes de stockage, l'intégration d'opérations CRUD dans vos modèles deviendra de plus en plus facile.