#Source de données REST API

#Présentation

Permet de connecter des données provenant d’une API REST.

#Installation

Ce plugin est un plugin commercial. Pour plus d’informations sur son activation, consultez le Guide d’activation des plugins commerciaux

#Ajouter une source REST API

Après avoir activé le plugin, sélectionnez REST API dans le menu déroulant Add new de la gestion des sources de données.

Configurer la source REST API

#Ajouter une Collection

Les ressources RESTful correspondent aux Collections de NocoBase, par exemple la ressource Users.

GET /users
POST /users
GET /users/1
PUT /users/1
DELETE /users/1

La configuration correspondante dans l’API NocoBase est la suivante

GET /users:list
POST /users:create
POST /users:get?filterByTk=1
POST /users:update?filterByTk=1
POST /users:destroy?filterByTk=1

Consultez la documentation de l’API pour connaître les spécifications complètes de conception de l’API NocoBase.

Consultez la section « NocoBase API - Core ».

La configuration de la Collection de la source de données REST API est la suivante.

#List

Configurez le mappage de l’interface permettant d’afficher la liste des ressources.

#Get

Configurez le mappage de l’interface permettant d’afficher les détails d’une ressource.

#Create

Configurez le mappage de l’interface permettant de créer une ressource.

#Update

Configurez le mappage de l’interface permettant de mettre à jour une ressource.

#Destroy

Configurez le mappage de l’interface permettant de supprimer une ressource.

Les interfaces List et Get sont obligatoires.

#Déboguer l’API

#Mappage des paramètres de requête

Exemple : configurer les paramètres de pagination pour l’interface List (si l’API tierce ne prend pas elle-même en charge la pagination, la pagination est effectuée à partir des données de la liste obtenue).

Veuillez noter que seules les variables déjà ajoutées dans l’interface seront prises en compte.

Cliquez sur Try it out pour effectuer un test et afficher le résultat de la réponse.

#Conversion du format de réponse

Le format de réponse de l’API tierce peut différer du format standard de NocoBase. Une conversion est nécessaire pour permettre un affichage correct dans l’interface.

Ajustez les règles de conversion en fonction du format de réponse de l’API tierce afin qu’il respecte le format de sortie standard de NocoBase.

Description du processus de débogage

#Conversion des informations d’erreur

Lorsqu’une erreur survient au niveau de l’API tierce, le format des informations d’erreur renvoyées peut différer du format standard de NocoBase. Une conversion est nécessaire pour permettre un affichage correct dans l’interface.

Si aucune conversion des informations d’erreur n’est configurée, elles sont converties par défaut en informations d’erreur contenant le code d’état HTTP.

Après avoir configuré la conversion des informations d’erreur, celles-ci sont adaptées au format de sortie standard de NocoBase, ce qui permet à l’interface d’afficher correctement les informations d’erreur de l’API tierce.

#Variables

La source de données REST API fournit trois catégories de variables pour le mappage des interfaces.

• Variables personnalisées de la source de données
• Requête NocoBase
• Réponse tierce

#Variables personnalisées de la source de données

#Requête NocoBase

• Params : paramètres de requête URL (Search Params), les Params peuvent varier selon l’interface ;
• Headers : corps de la requête, fournissant principalement certaines informations personnalisées X- de NocoBase ;
• Body : corps de la requête ;
• Token : jeton API de la requête NocoBase actuelle.

#Réponse tierce

Pour le moment, seul le Body de la réponse est fourni.

Les variables disponibles pour chaque interface sont les suivantes :

#List

#Get

#Create

#Update

#Destroy

#Configurer les champs

Extrayez les métadonnées des champs (Fields) à partir des données des interfaces CRUD de la ressource adaptée, afin de les utiliser comme champs de la Collection.

Extraire les métadonnées des champs.

Champs et aperçu.

Modifier les champs (de manière similaire aux autres sources de données).

#Ajouter un bloc de source de données REST API

Une fois la Collection configurée, vous pouvez ajouter des blocs dans l’interface.