DEV {JS}

Mode sombre

🛡️ Bonnes pratiques avec les API ​

Travailler avec une API demande d’adopter des méthodes pour garantir la sécurité, la performance et la maintenabilité du projet.

🗂️ Centraliser les appels API ​

  • Regroupez toutes les fonctions d’accès Ă  l’API dans un dossier ou fichier dĂ©diĂ© (ex : src/services/api.js).
  • Cela facilite la maintenance et Ă©vite la duplication du code.

♻️ Réutiliser les fonctions de requête ​

  • CrĂ©ez des fonctions pour chaque type de requĂŞte (ex : getPokemons, getPokemonById).
  • Utilisez-les partout dans l’application pour garder un code cohĂ©rent.

🚦 Limiter les appels et éviter la surcharge ​

  • Stockez les donnĂ©es dans un store (ex : Pinia) pour ne pas refaire la mĂŞme requĂŞte inutilement.
  • Mettez en place un cache ou vĂ©rifiez si les donnĂ©es existent dĂ©jĂ  avant de relancer une requĂŞte.

📊 Gérer les quotas et les erreurs ​

  • VĂ©rifiez si l’API impose des limites d’utilisation (quotas).
  • GĂ©rez les erreurs avec des blocs try / catch et affichez des messages clairs Ă  l’utilisateur.

🔒 Sécuriser les clés et URLs avec des variables d’environnement ​

  • Stockez les URLs, clĂ©s d’API et tokens dans un fichier .env (jamais dans le code source).
  • Ajoutez un fichier .env.example pour indiquer aux autres dĂ©veloppeurs quelles variables sont nĂ©cessaires.
  • Ne versionnez jamais le fichier .env : ajoutez-le dans le .gitignore pour Ă©viter de publier des informations sensibles.

Exemple de .env.example :

txt
VITE_APP_API_URL=http://pokeapi.co/api/v2
VITE_APP_API_KEY=your_api_key_here

Exemple d’entrée dans .gitignore :

txt
.env

🧪 Préparer un mock ou des données factices ​

  • CrĂ©ez un serveur mock ou des fichiers JSON pour simuler les rĂ©ponses de l’API.
  • Utilisez ces mocks pour le dĂ©veloppement ou les tests si l’API rĂ©elle est indisponible.

📚 Documenter et tester ​

  • Documentez chaque fonction d’accès Ă  l’API (paramètres, rĂ©ponses, erreurs).
  • Écrivez des tests unitaires pour vĂ©rifier le comportement de vos fonctions, y compris en cas d’erreur.

TIP

En appliquant ces bonnes pratiques, votre code sera plus robuste, sécurisé et facile à maintenir.