Aller à l'article
Aniq-UI

Dashboard 2La fausse API intégrée

La fausse API intégrée

Comment le tableau de bord fonctionne sans back-end sur des données d'exemple conservées dans le navigateur, ce qui y marche, et comment le basculer vers votre API ou le retirer.

Pour le pack Front + Back

Description

Le tableau de bord embarque un petit serveur à lui qui tourne dans le navigateur. Il répond à chaque requête du tableau de bord, avec les mêmes réponses, codes d'état et vérifications de permissions que l'API NestJS, si bien que chaque écran fonctionne sans aucun back-end. C'est ce sur quoi le pack Admin Dashboard tourne tout de suite, et ce vers quoi le tableau de bord du Full Stack se replie quand aucune adresse d'API n'est définie.

Un avis « Sample data » s'affiche en bas de chaque page pendant qu'elle répond, pour que personne ne la prenne pour un back-end connecté.

L'activer et la désactiver

Il n'y a pas d'option. Un seul paramètre décide, NEXT_PUBLIC_API_BASE_URL, compilé au moment du build du tableau de bord :

.env
# empty or missing: the mock API, no back-end needed
NEXT_PUBLIC_API_BASE_URL=

# set: your API, the mock never runs
NEXT_PUBLIC_API_BASE_URL=http://localhost:8000/api
  • Sans Docker, le tableau de bord sans fichier .env tourne sur la fausse API. Redémarrez yarn dev, ou relancez yarn build, après avoir changé la valeur.
  • Une image Docker construite sans --build-arg tourne sur la fausse API. Docker Compose construit toujours le tableau de bord avec l'adresse de l'API.
  • Quand un navigateur qui a utilisé la fausse API est relié à une vraie API, le tableau de bord abandonne la session et les données d'exemple qu'il avait gardées, pour que la première requête ne soit pas faite avec un jeton que l'API refuserait.

Ce qui y fonctionne

DomaineSur la fausse API
ConnexionLes comptes d'exemple : admin@example.com avec Admin@123 (Super Admin), et les Viewers d'exemple comme john.smith@admin.com avec admin123. Un mauvais mot de passe est refusé, comme sur l'API.
DonnéesLes données d'exemple de l'API elle-même : 12 admins, 5 rôles et 25 permissions, 15 utilisateurs et 12 supprimés, 15 projets et 12 supprimés, les 10 tâches du Super Admin, 13 paramètres d'application et 50 pays, plus trois conversations d'assistant antérieures.
ModificationsRéelles : créer, modifier, supprimer, restaurer, accorder une permission et renommer un rôle changent les données et survivent à un rechargement, dans ce navigateur uniquement.
PermissionsVérifié à partir des rôles de l'admin connecté et refusé comme l'API le refuse, si bien qu'un Viewer voit exactement ce que voit un compte en lecture seule.
ImagesUne photo envoyée est conservée dans le navigateur et s'affiche ; rien ne le quitte.
Assistant IAUn seul modèle, Aniq Demo, avec des réponses scriptées construites à partir des données actuelles : chiffres, cartes, listes et un graphique. Aucun fournisseur, aucune clé.

Chaque réponse est retardée d'une fraction de seconde exprès, pour que les états de chargement fournis avec le tableau de bord soient visibles.

Repartir de zéro

Effacez les données du site pour l'adresse du tableau de bord dans les paramètres de votre navigateur, ou lancez ceci dans la console du navigateur, et les exemples reviennent tels qu'ils étaient livrés :

Console du navigateur
localStorage.removeItem("mock_db_v1"); location.reload();

La retirer

Quand vous tournez durablement sur votre propre API, supprimez la fausse API du code, dans le dossier du tableau de bord :

Terminal
yarn remove:mock

Il supprime src/lib/mock/ et l'avis de données d'exemple, et retire les blocs marqués #region mock-api. Le tableau de bord a ensuite besoin que NEXT_PUBLIC_API_BASE_URL soit défini. Il réécrit des fichiers et ne peut pas être annulé sans gestion de versions, alors faites d'abord un commit.

Comment il est construit

Inclus avec votre achat. Connectez-vous pour le lire, ou ouvrez-le dans votre téléchargement.

Où vit la fausse API, comment une requête l'atteint, et comment ajouter une route à vous.

Bloqué sur une étape ?

Trouvez une solution avant de tout recommencer.

Dépannage

Préférences des Cookies

Nous utilisons des cookies pour améliorer votre expérience de navigation, analyser le trafic du site et personnaliser le contenu. En cliquant sur "Accepter Tout", vous consentez à notre utilisation des cookies pour l'analyse et la publicité personnalisée.