Les endpoints sont une partie essentielle des processus d'affaires et du développement d'applications en général. Dans cet article, nous définissons ce que sont les endpoints, pourquoi nous en avons besoin et comment les créer sur la plateforme AppMaster.io.
Qu'est-ce qu'un endpoint ?
Un endpoint est une passerelle qui connecte les processus du serveur de l'application avec une interface externe. En d'autres termes, il s'agit de l'adresse à laquelle les demandes sont envoyées.
Il est important de mentionner le fonctionnement de l'API pour comprendre ce que sont les endpoints. API est une abréviation pour une interface de programmation d'application. Les applications utilisent les API pour interagir avec des services tiers et leurs utilisateurs.
Pour se connecter à l'API, il faut envoyer une requête. Pour un traitement correct de la requête, le client doit fournir un pointeur de ressource universel (URL), une méthode HTTP et, selon la méthode, ajouter des en-têtes, un corps et des paramètres de requête. Les en-têtes fournissent des métadonnées sur la demande, tandis que le corps contient des données, telles que des champs pour les nouvelles lignes de la base de données.
L'API traitera la demande et enverra la réponse reçue du serveur. La réponse contiendra un code d'état, qui est une partie du message de réponse HTTP informant le client du résultat de la demande. Par exemple, le code 200 est utilisé si l'opération s'est terminée avec succès, 500 si une erreur interne au serveur s'est produite.
Les points d'extrémité fonctionnent avec les méthodes de l'API. Ce sont des URL spécifiques que l'application utilise pour communiquer avec des services tiers et ses utilisateurs. Une URL est une route qui peut gérer différentes méthodes de requête. Chaque type de requête est un point de terminaison distinct. Il existe cinq types principaux :
- GET - obtient des informations du serveur ; il ne nécessite pas de corps de requête ;
- POST - crée un nouvel objet dans la base de données, nécessite un corps de requête avec les champs de cet objet ;
- PUT - réinitialise complètement un objet spécifique dans la base de données ;
- PATCH - similaire à PUT, réinitialise un objet spécifique dans la base de données, mais il ne mettra à jour que les champs qui sont mentionnés dans le corps de requête ;
- DELETE - supprime l'objet de la base de données.
Lors de la création d'une requête spécifique, différents paramètres peuvent lui être ajoutés. La combinaison de ces paramètres et de l'URL représente un URI - Uniform Resource Identifier. Elle indique où et comment trouver la ressource.
Comment configurer les endpoints sur la plateforme AppMaster.io?
Dans la section Endpoints de la plateforme AppMaster.io, vous pouvez voir tous les endpoints générés automatiquement et les endpoints de votre projet. Si l'auto-génération des écrans et des pages dans votre projet est activée, il y aura automatiquement créé les endpoints correspondants pour tout modèle de données créé. De même, les endpoints peuvent être créés automatiquement lors de l'installation de certains modules, par exemple, Autorisation (Auth), Pays et villes, et autres.
AppMaster.io vous permet de travailler avec plusieurs types d'API de points de terminaison :
- API pour accéder au backend depuis le client et des systèmes tiers ;
- webhooks pour recevoir des notifications de systèmes tiers ;
- WebSockets, pour ouvrir une session de communication interactive bidirectionnelle entre un navigateur et un serveur sans demander au serveur une réponse.
Tous les endpoints sont regroupés. Dans chaque groupe, vous trouverez tous les points d'extrémité correspondants, leurs types de demande, leurs URL et les processus métier auxquels ils sont connectés. Tous les points de terminaison peuvent être supprimés et modifiés par vous.
Lorsque vous créez ou modifiez un point de terminaison, les options suivantes sont disponibles dans la fenêtre de configuration :
- Méthode de requête. GET, POST, PUT, DELETE ou PATCH.
- Request URL. La première partie avec le chemin d'accès au serveur n'est pas spécifiée car elle est la même pour tous les endpoints de l'application. Il suffit de définir la fin, par exemple, /users. Le paramètre URL est également spécifié ici. Supposons que l'endpoint soit conçu pour recevoir des informations sur un utilisateur spécifique. Dans ce cas, son ID doit être écrit après " :" (/users/:id) et passé en paramètre.
- Groupes de points de terminaison. Ce paramètre vise à organiser et à structurer le travail avec les endpoints. Tous les endpoints peuvent être divisés en groupes (dossiers).
- Processus d'affaires. L'un des paramètres les plus critiques qui déterminent ce que fera l'endpoint. Dans le même temps, l'endpoint lui-même peut rester inchangé. Il recevra toutes les mêmes demandes à l'ancienne adresse, et si le processus métier est remplacé, il exécutera une fonction différente. Les processus métier pour les opérations de base de la base de données sont créés automatiquement. Vous ne pouvez pas les modifier, mais si nécessaire, vous pouvez les remplacer par des BP personnalisés.
Vous pouvez également configurer un middleware. L'intergiciel est un logiciel intermédiaire qui sert de filtre lors du traitement des demandes de l'application. L'intergiciel est utilisé pour vérifier toutes les conditions avant d'exécuter une demande. Par exemple, si vous créez un intergiciel pour vérifier l'authentification de l'utilisateur, l'intergiciel redirigera l'utilisateur vers la page de connexion si l'utilisateur n'est pas connecté. S'il est connecté, l'intergiciel n'interviendra pas dans le traitement de la requête, la transmettant au client.
Créer un endpoint dans AppMaster.io
Envisageons la configuration des endpoints dans la pratique et analysons-la à travers l'exemple du projet Aviato. Vous pouvez trouver le processus complet de création de ce projet sur le cours AppMaster.io.
Au sein du projet, nous avons créé deux processus métier:
- Valider et créer des vols - le processus qui sera utilisé pour remplacer le processus métier Créer un vol;
- Enregistrer un passager - pour enregistrer un passager pour un vol spécifique.
Nous pouvons maintenant utiliser ces processus pour mettre en place des points de terminaison dans le projet.
Démarrons avec le processus métier Valider et créer des vols. Le groupe Vol a déjà un endpoint POST/flights pour créer un vol. Maintenant, nous devons remplacer le processus métier attaché par un nouveau processus. Pour ce faire, nous devons modifier le point de terminaison.
Dans la fenêtre de configuration, sélectionnez le processus métier souhaité. Dans notre cas, il s'agit d'un BP de validation et de création de vols. Après cela, nous devons sélectionner toutes les variables d'entrée requises et enregistrer les modifications.
Nous pouvons maintenant configurer le prochain endpoint pour le processus métier Enregistrer un passager.
Notre objectif est de créer une section permettant de visualiser un vol spécifique et les passagers qui lui sont associés et de configurer un processus d'enregistrement de nouveaux passagers.
Dans le groupe d'endpoints Vols, nous devons créer un nouvel endpoint : /flights/:id/register, où id fait référence à un vol spécifique que nous pouvons utiliser comme entrée dans un processus métier.
En cliquant sur l'icône Plus, nous pouvons ajouter un nouveau endpoint. La méthode de requête sera POST puisque nous créons un nouvel objet. Nous sélectionnons le processus Register passenger pour notre BP et enregistrons toutes les modifications apportées.
Voilà à quel point il est facile de créer des endpoints sur la plateforme AppMaster.io. Tutoriel vidéo complet:
Conclusion
Les endpoints jouent un rôle essentiel dans le fonctionnement de l'API, qui, à son tour, est nécessaire pour l'expansion des projets et l'intégration pratique des services et des applications. La plateforme No-code AppMaster.io permet de travailler facilement avec les endpoints, de les créer et de les configurer. Vous pouvez toujours vous inscrire sur la plateforme et vérifier toutes les fonctionnalités.
