Informations générales

Le dernier module s'est terminé par la création du premier processus d'entreprise. Nous avons compris comment créer une logique de processus, accepter des paramètres d'entrée spécifiques, effectuer des calculs et émettre une réponse. Il reste à répondre à la question principale. Comment activer le processus métier créé et le mettre en service ?

Pour résoudre ce problème, on prévoit des points d'extrémité - des points clés d'interaction avec l'application. Dans les premiers modules, nous avons déjà interagi avec des API externes. Cela a été possible grâce à la présence de points de terminaison. Ils étaient décrits dans la documentation, nous l'avons lue et avons compris quelle méthode et quelle URL il fallait envoyer une requête pour accéder à une ressource spécifique.

Pour mieux comprendre, examinons l'implémentation des endpoints à l'aide d'un exemple spécifique. Dans le troisième module, le modèle de base de données a été créé. En même temps que la création des tables, des endpoints ont été automatiquement créés pour interagir avec elles. Allons dans la section endpoints (sur le panneau de gauche) et regardons-les.

Dans l'exemple de la table "city" contenant des informations sur les villes, on peut voir qu'elle possède déjà 6 terminaux pour les opérations de base sur les données.

• GET /city - obtenir toutes les données d'un tableau
• GET /city/:id - obtenir des données sur la ville avec l'identifiant spécifié
• POST /city - ajout d'un nouvel enregistrement à la table
• PUT /city/:id - remplacement complet de l'enregistrement avec l'identifiant spécifié dans la table
• PATCH /city/:id - remplacement partiel de l'enregistrement ayant l'identifiant spécifié dans le tableau
• DELETE /city/:id - suppression d'un enregistrement de la table ayant l'identifiant spécifié.

Paramètres généraux

Vous pouvez ouvrir les paramètres de chaque endpoint et l'étudier plus en détail. Par exemple, considérons le point de terminaison GET /city/:id

L'image que nous voyons est très similaire à celle que nous avons déjà vue lors de la création d'une requête vers des API externes. Dans un cas, nous avons seulement accédé à un point de terminaison prêt à l'emploi, et maintenant nous créons et configurons ce point de terminaison nous-mêmes. Pour configurer, vous devez spécifier :

1. Laméthode de requête. Dans cet exemple, il s'agit de la méthode GET.
2. L'URL de la demande. La première partie avec le chemin vers le serveur n'est pas spécifiée. Elle est la même pour tous les points de terminaison de l'application. Il suffit de spécifier la fin (/city). Le paramètre URL est également spécifié ici. Le point de terminaison est conçu pour recevoir des informations sur une ville particulière, son identifiant écrit après " :" est donc passé en paramètre.
3. Endpoint Groups. Ce paramètre n'affecte en aucune façon le fonctionnement du point de terminaison et n'est prévu que pour la commodité de l'organisation. Tous les endpoints peuvent être divisés en groupes thématiques (dossiers). Dans cet exemple, le groupe "city" contient tous les endpoints permettant de travailler avec des données sur les villes.
4. Business Process. Il s'agit de l'élément de configuration le plus important, qui ne peut être vu d'aucune manière lors de l'envoi d'une requête au endpoint. L'indication du processus d'affaires détermine ce que ce point final fera. En même temps, le point final lui-même peut rester inchangé, il recevra toutes les mêmes demandes à l'ancienne adresse, et en même temps, si le processus d'affaires est remplacé, il exécutera une fonction complètement différente. Les processus métier pour les activités de base de la base de données sont créés automatiquement. Ils sont appelés processus métier système. Ces BP ne peuvent pas être modifiés mais peuvent être remplacés à tout moment par des BP créés indépendamment, avec des processus métier personnalisés.
5. Input/Output variables. Le processus métier créé utilise diverses variables d'entrée et de sortie, mais le point final n'est pas obligé de les utiliser toutes. Une partie peut être désactivée ou configurée de manière à ce que différents points d'extrémité accèdent à la même BP, avec un ensemble individuel de variables. Le type de demande et de réponse (Request / Response type) est également configuré à cet endroit. Le plus souvent, ce type sera JSON, mais, si nécessaire, d'autres options peuvent être utilisées, comme XML ou Render File (ce type de réponse est utilisé dans les endpoints pour travailler avec des fichiers).

Paramètres de l'intergiciel

Les paramètres généraux sont suffisants pour créer et utiliser le point de terminaison, mais des paramètres supplémentaires peuvent être utilisés si nécessaire. Le plus important d'entre eux est l'activation de Middleware avec un jeton Auth.

Son utilisation vous permet de refuser l'accès à ce point de terminaison aux utilisateurs qui n'ont pas été autorisés ou qui n'appartiennent pas à un certain groupe (par exemple, l'accès peut être accordé uniquement aux administrateurs et refusé aux autres utilisateurs).

Paramètres de journalisation et de sortie

En outre, vous pouvez utiliser les paramètres de l'onglet Settings pour ajouter des en-têtes de journal ou le corps de la requête, ainsi que pour masquer de la réponse les champs dont les valeurs ne sont pas définies.