Cet article vous montrera comment travailler avec les API sur notre plateforme sans code de niveau professionnel, AppMaster.io. Mais, tout d'abord, rappelons quelques informations de base sur l'API.
introduction
API signifie Application Programming Interface. C'est ainsi que le client et le serveur peuvent communiquer entre eux. Le client et le serveur envoient des requêtes et des réponses, et l'API agit comme un intermédiaire entre eux.
Cette interaction client-serveur doit être simple, compréhensible et pratique. Il simplifie à la fois les tâches des développeurs (pas besoin de réinventer un nouveau service) et des utilisateurs (un service est plus facile à apprendre s'il fonctionne familièrement). Il existe plusieurs types d'API :
- API de service Web, XML-RPC et JSON-RPC, SOAP ;
- API WebSockets ;
- API basées sur une bibliothèque, Java Script ;
- API basées sur les classes, API C#, Java.
Sur la plateforme sans code AppMaster.io, nous utilisons le style API REST.
REST ou l'ensemble du transfert d'état représentatif est le style architectural d'interaction (échange d'informations) entre le client et le serveur. Les services de l'API REST communiquent à l'aide du protocole HTTP.
Le style REST présente certains avantages. Le principal avantage de REST est une excellente flexibilité. REST se compose de directives simples, permettant aux développeurs d'implémenter les exigences dans leur format. REST a des performances élevées, ce qui est très important, par exemple, pour un chargement rapide sur les appareils mobiles. C'est pourquoi toutes les grandes entreprises telles que Twitter et Google ont depuis longtemps implémenté l'API REST pour leurs produits. Vous pouvez en savoir plus sur le travail et les principaux avantages de l'API REST dans notre article.
La structure de toute demande comprend cinq composants principaux : la méthode HTTP, les points de terminaison, les en-têtes et le corps, les paramètres de la demande.
L'API REST utilise 4 méthodes HTTP de base pour travailler avec une ressource (information), et chacune d'entre elles décrit ce qu'il convient de faire avec la ressource :
- POST — création de ressources ;
- GET — obtenir une ressource ;
- PUT — mise à jour des ressources ;
- DELETE — suppression d'une ressource.
Une ressource est toute information (document, image, vidéo, texte, etc.). Sur la plate-forme sans code AppMaster.io, ces informations sont fournies au client dans plusieurs formats, dont le plus courant : JSON.
Le point de terminaison contient un URI — Uniform Resource Identifier (identificateur de ressource uniforme), qui indique où et comment trouver une ressource sur Internet et inclut une URL (URL ou Uniform Resource Location est une adresse Web complète).
Les en-têtes transmettent des informations à la fois au client et au serveur. Les en-têtes fournissent principalement des données d'authentification : une clé API, le nom ou l'adresse IP de l'ordinateur sur lequel le serveur est installé, et le format de la réponse.
Le corps est nécessaire pour transmettre des informations supplémentaires au serveur : les données du corps sont des données que vous souhaitez, par exemple, ajouter ou remplacer.
La documentation API de votre application sur notre plateforme est générée automatiquement et stockée au format OpenAPI (Swagger) dans son backend.
Vous n'avez pas besoin de comprendre précisément son fonctionnement pour apprendre à créer une API sur AppMaster.io. Vous comprendrez les principes de base en vous familiarisant avec les outils de la plateforme. De plus, la partie centrale de l'API est créée par AppMaster.io. La plupart des réglages sont effectués par défaut ou lors de la connexion des modules. Par exemple, notre module fournit des outils d'intégration avec les API pour le courrier.
Vous devrez apporter manuellement de petites modifications à certains paramètres de l'API lors de l'intégration (connexion) de votre application à d'autres applications ou ressources externes. Ensuite, nous verrons comment procéder.
Création d'API à l'aide de la plateforme sans code AppMaster.io
Ainsi, vous pouvez trouver des paramètres d'API à plusieurs endroits sur notre plateforme.
Comment créer un API Endpoint sur la plateforme no-code AppMaster.io
Connectez-vous à votre compte pour un projet existant.
Accédez à Concepteur de modèle de données. Dans Data Model Designer, vous verrez des modèles avec des données que vous souhaitez traiter à l'aide de l'API des points de terminaison. Dans chaque projet, au départ, il y a toujours un modèle par défaut, l'Utilisateur. Si vous êtes dans un nouveau projet et que vous n'avez pas encore vos modèles, créez-les.
Attribuez des liens entre vos modèles et enregistrez le projet.
Accédez à la section Endpoints dans le menu de gauche de l'écran.
Ici, vous verrez une liste de tous vos points de terminaison et des méthodes d'API REST disponibles pour eux connectés à chaque modèle dans le champ du projet. Vous supprimerez les méthodes inutiles et modifierez leurs paramètres (icône d'engrenage et icône de la corbeille).
S'il n'y a pas de point de terminaison approprié dans la liste, vous pouvez en créer un nouveau en cliquant sur le bouton Nouveau point de terminaison et en sélectionnant le type approprié. Une fenêtre modale avec les paramètres Endpoint s'ouvrira.
Comment créer une API externe sur la plateforme no-code AppMaster.io
Accédez à la section Business Logic dans le menu de gauche.
Ici, vous pouvez créer une demande d'API externe dans l'onglet Demande d'API externe (cette option est en version bêta).
De plus, comme nous l'avons mentionné ci-dessus, toute la documentation est générée automatiquement et enregistrée au format OpenAPI (Swagger) dans le backend de votre application.
Swagger est une documentation et la possibilité de tester tous les points de terminaison sur place sans utiliser d'applications tierces telles que Postman.
Conclusion
Comme vous pouvez le voir, créer et modifier les paramètres de l'API sans code est très simple et prend un minimum de temps. Si vous n'avez pas encore de compte sur AppMaster.io, rejoignez-nous et inscrivez-vous pour une version d'essai .
