Cette documentation a été traduite automatiquement par IA.
Source de données REST API
This feature is provided by the commercial plugin «Source de données : REST API», please purchase to useIntroduction
Ce plugin vous permet d'intégrer facilement des données issues de sources REST API.
Installation
Étant un plugin commercial, vous devez le télécharger et l'activer via le gestionnaire de plugins.
Ajout d'une source de données REST API
Après avoir activé le plugin, vous pouvez ajouter une source de données REST API en la sélectionnant dans le menu déroulant « Ajouter nouveau » de la section de gestion des sources de données.
Configurez la source de données REST API.
Ajout d'une collection
Dans NocoBase, une ressource RESTful est mappée à une collection, comme par exemple une ressource Utilisateurs.
Ces points d'API sont mappés dans NocoBase comme suit :
Pour un guide complet sur les spécifications de conception de l'API NocoBase, veuillez consulter la documentation de l'API.
Consultez le chapitre « NocoBase API - Core » pour des informations détaillées.
La configuration de la collection pour une source de données REST API comprend les éléments suivants :
List
Mappez l'interface pour afficher une liste de ressources.
Get
Mappez l'interface pour afficher les détails d'une ressource.
Create
Mappez l'interface pour créer une ressource.
Update
Mappez l'interface pour mettre à jour une ressource.
Destroy
Mappez l'interface pour supprimer une ressource.
Les interfaces List et Get sont toutes deux obligatoires et doivent être configurées.
Débogage de l'API
Intégration des paramètres de requête
Exemple : Configurez les paramètres de pagination pour l'API List. Si l'API tierce ne prend pas en charge la pagination nativement, NocoBase paginera en fonction des données de liste récupérées.
Veuillez noter que seules les variables ajoutées dans l'interface prendront effet.
| Nom du paramètre de l'API tierce | Paramètre NocoBase |
|---|---|
| page | {{request.params.page}} |
| limit | {{request.params.pageSize}} |
Vous pouvez cliquer sur « Essayer » (Try it out) pour déboguer et visualiser la réponse.
Transformation du format de réponse
Le format de réponse de l'API tierce peut ne pas être conforme au standard NocoBase ; il doit être transformé pour s'afficher correctement sur le frontend.
Ajustez les règles de conversion en fonction du format de réponse de l'API tierce pour vous assurer que la sortie est conforme au standard NocoBase.
Description du processus de débogage
Variables
La source de données REST API prend en charge trois types de variables pour l'intégration d'API :
- Variables personnalisées de la source de données
- Variables de requête NocoBase
- Variables de réponse tierces
Variables personnalisées de la source de données
Requête NocoBase
- Params : Paramètres de requête URL (Search Params), qui varient selon l'interface.
- Headers : En-têtes de requête personnalisés, fournissant principalement des informations X- spécifiques de NocoBase.
- Body : Le corps de la requête.
- Token : Le jeton API pour la requête NocoBase actuelle.
Réponses tierces
Actuellement, seul le corps de la réponse est disponible.
Voici les variables disponibles pour chaque interface :
List
| Paramètre | Description |
|---|---|
| request.params.page | Page actuelle |
| request.params.pageSize | Nombre d'éléments par page |
| request.params.filter | Critères de filtrage (doit respecter le format de filtre NocoBase) |
| request.params.sort | Critères de tri (doit respecter le format de tri NocoBase) |
| request.params.appends | Champs à charger à la demande, généralement pour les champs d'association |
| request.params.fields | Champs à inclure (liste blanche) |
| request.params.except | Champs à exclure (liste noire) |
Get
| Paramètre | Description |
|---|---|
| request.params.filterByTk | Obligatoire, généralement l'ID de l'enregistrement actuel |
| request.params.filter | Critères de filtrage (doit respecter le format de filtre NocoBase) |
| request.params.appends | Champs à charger à la demande, généralement pour les champs d'association |
| request.params.fields | Champs à inclure (liste blanche) |
| request.params.except | Champs à exclure (liste noire) |
Create
| Paramètre | Description |
|---|---|
| request.params.whiteList | Liste blanche |
| request.params.blacklist | Liste noire |
| request.body | Données initiales pour la création |
Update
| Paramètre | Description |
|---|---|
| request.params.filterByTk | Obligatoire, généralement l'ID de l'enregistrement actuel |
| request.params.filter | Critères de filtrage (doit respecter le format de filtre NocoBase) |
| request.params.whiteList | Liste blanche |
| request.params.blacklist | Liste noire |
| request.body | Données pour la mise à jour |
Destroy
| Paramètre | Description |
|---|---|
| request.params.filterByTk | Obligatoire, généralement l'ID de l'enregistrement actuel |
| request.params.filter | Critères de filtrage (doit respecter le format de filtre NocoBase) |
Configuration des champs
Les métadonnées des champs (Fields) sont extraites des données de l'interface CRUD de la ressource adaptée pour servir de champs à la collection.
Extrayez les métadonnées des champs.
Champs et aperçu.
Modifiez les champs (de manière similaire aux autres sources de données).
Ajout de blocs de source de données REST API
Une fois la collection configurée, vous pouvez ajouter des blocs à l'interface.
