Exemple d’API Rust : utilisateurs, groupes et relations

Exemple testé le avec Miblo 0.9.1 · NaSuRall

Relier User et Group dans une API Rust : générer une clé étrangère SQL, conserver les données et ajouter POST /members avec Miblo CLI.

Dans cette page

Partir d’une API fonctionnelle

Suivez d’abord le tutoriel Axum et SQLite, jusqu’au POST qui crée Alice. Exécutez les commandes suivantes dans team-api. Cet exemple utilise SQLite en local, Miblo 0.9.1 et les templates 0.6.0.

Nous allons rattacher chaque utilisateur à un groupe facultatif. Miblo génère les types Rust, la migration SQL et les requêtes CRUD. Les droits et règles d’appartenance au groupe restent à écrire.

1. Ajouter Group et la clé étrangère

Arrêtez l’API avec Ctrl+C dans son terminal, ou s si Miblo l’a lancée. Exécutez ensuite :

shell
miblo add Group name:string --yes
miblo edit User 'group_id:int?:ref=Group' --yes
miblo db migrate
miblo run

int? rend le champ facultatif ; ref=Group référence groups.id. Les utilisateurs existants conservent leurs identifiants, noms et e-mails ; leur nouveau group_id vaut NULL. La migration ajoute la clé étrangère et son index.

TableClé primaireRelation
groupsidUn groupe peut être référencé par plusieurs utilisateurs.
usersidgroup_id → groups.id, facultatif.

La relation est une clé étrangère : le JSON ne contient pas d’objet Group imbriqué. Par défaut, la suppression utilise RESTRICT : détachez les utilisateurs avant de supprimer leur groupe. Options des relations →

2. Vérifier qu’Alice est toujours présente

Laissez l’API tourner. Dans un second terminal :

shell
curl http://127.0.0.1:3000/users/1

Pour Alice créée comme premier utilisateur dans le tutoriel, la réponse est :

json
{"id":1,"name":"Alice","email":"alice@example.com","group_id":null}

Aucune ligne existante n’a été supprimée ou remplacée. Consultez les modifications de modèles et migrations pour faire évoluer votre propre projet.

3. Créer un groupe et l’attribuer

shell
curl -i http://127.0.0.1:3000/groups \
  -H 'Content-Type: application/json' \
  -d '{"name":"Engineering"}'

curl -i -X PATCH http://127.0.0.1:3000/users/1 \
  -H 'Content-Type: application/json' \
  -d '{"group_id":1}'

Le POST du groupe renvoie 201 ; le PATCH de l’utilisateur renvoie 200 avec group_id: 1. Remplacez les deux identifiants par les valeurs réellement reçues si votre base contient déjà des lignes. Une référence à un groupe inexistant renvoie 400.

Dans l’interface, créez Group avec a, puis modifiez User avec m et choisissez un champ relation. Appliquez la migration avec b, redémarrez l’API et consultez le schéma avec d. La touche x permet de tester les routes avec un formulaire.

4. Ajouter POST /members sur le modèle User

Arrêtez à nouveau l’API. Cette commande ajoute une autre URL de création qui utilise le code SQL existant de User :

shell
miblo route add create_member --resource User --action create --path /members --yes
miblo run

Dans le second terminal :

shell
curl -i http://127.0.0.1:3000/members \
  -H 'Content-Type: application/json' \
  -d '{"name":"Bob","email":"bob@example.com","group_id":1}'

Résultat attendu : HTTP 201. Bob est inséré dans users et apparaît dans GET /users ; aucune table members n’est créée. Dans l’interface, appuyez sur g, choisissez User et l’action de création, puis indiquez /members.

--action create branche la route sur le SQL généré. Associer un modèle sans choisir d’action crée seulement une fonction à compléter. Options des routes personnalisées →

Où ajouter votre code

Placez les règles d’appartenance aux groupes dans src/resources/user/service.rs et vos requêtes SQL ou jointures dans repository.rs. L’authentification, les droits d’accès et le déploiement restent à développer dans votre application. Lire le code généré →

Ce parcours a été exécuté avec SQLite. Miblo génère aussi des projets MySQL, qui nécessitent un serveur démarré et une connexion configurée.

Rechercher une fonctionnalité ou une commande.

↑ ↓ parcourir Entrée ouvrir