RAML
RAML (RESTful API Modeling Language) est un langage basé sur YAML pour la description des API RESTful. RAML fournit également des fonctionnalités permettant de documenter de manière exhaustive une API RESTful, d'extraire la documentation utilisateur via des outils de génération de documentation, puis de convertir celle-ci en formats visuels tels que PDF, HTML, etc.
 |
La version 0.8 de la spécification RAML est prise en charge.
|
Utilisez cette action pour accéder aux API et effectuer des appels API sur le service pour lequel les API sont générées à l'aide de RAML.
Utilisation de l'action RAML
Pour utiliser cette action dans votre processus, connectez-la à ThingWorx Flow. Pour ce faire, procédez comme suit :
1. Cliquez sur 
, faites glisser l'action RAML sous l'utilitaire Conception d'API jusqu'au canevas, placez le pointeur sur l'action, puis cliquez sur 
ou double-cliquez sur l'action. La fenêtre de l'action RAML s'ouvre.
, faites glisser l'action RAML sous l'utilitaire Conception d'API jusqu'au canevas, placez le pointeur sur l'action, puis cliquez sur ou double-cliquez sur l'action. La fenêtre de l'action RAML s'ouvre.2. Modifiez le nom de l'étiquette, si nécessaire. Par défaut, le nom de l'étiquette est identique à celui de l'action.
3. Dans le champ URL fichier racine, spécifiez l'URL où récupérer le fichier ZIP contenant le fichier RAML racine et ses dépendances.
4. Dans le champ Nom fichier racine, spécifiez le nom du fichier RAML racine à récupérer.
5. Cliquez sur Récupérer pour configurer l'API sous-jacente.
6. Cliquez sur Terminé.
Schéma de sortie
L'action RAML renvoie un schéma de sortie du type illustré ci-dessous :
