Outils pour utilisateurs

Outils du site


cours:informatique:dev:decouverte_api_rest:310_conception_api

Notes et transcriptions du cours Débutez avec les API REST proposé par esri France disponible sur la plateforme Openclassrooms.

Préparer la conception de votre API

La mise en place d'une API, c'est comme la mise en place d'un projet informatique. Vous devez respecter certaines étapes pour optimiser votre temps de développement et de mise en ligne de votre API.

4 étapes sont conseillées dans la conception d'une API :

  1. Concevoir l'API : comment vais-je construire mon API ? Quelles ressources je mets à disposition avec mon API ?
  2. Construire l'API : c'est l'étape de développement.
  3. Comment utiliser l'API : il s'agit de rédiger la documentation.
  4. Faire connaître l'API.

Vous allez aborder tous ces points dans cette dernière partie.

Réfléchissez avant de construire votre API

Trop souvent impatient, le développeur se lance dans son développement sans avoir pris le temps de mettre sur papier ses besoins, la spécification et la conception de ses besoins finaux pour son projet informatique.

Vous manquez de temps ? Votre client est pressé ? Eh bien, formalisez vos idées, vos besoins, les besoins du client avant tout démarrage de développement de votre API. Vous gagnerez un temps précieux !

Apprenez à connaître les applications et leur contraintes d'utilisation avant toute chose. Les questions à vous poser :

  • Comment vais-je construire mon API ?
  • REST ou SOAP ?
  • Qu'est-ce que je vais mettre à disposition dans mon API ?

Par exemple, pour votre projet informatique de e-commerce, les entités principales sont les clients et les commandes. Vous mettrez à disposition par exemple des fonctions permettant de récupérer les commandes d'un client, de voir l'état d'une commande d'un client, etc.

Vérifiez que l’API n’existe pas

Avant de vous lancer dans la conception, jetez un œil sur le web pour être sûr que l'API que vous voulez concevoir n'existe pas déjà !

◁ Précédent | ⌂ Retour au sommaire | Suivant ▷

cours/informatique/dev/decouverte_api_rest/310_conception_api.txt · Dernière modification : 2023/09/23 16:54 de yoann