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.
Utilisez l'action RAML pour accéder aux API et effectuer des appels d'API aux services pour lesquels des API sont générées à l'aide de RAML. L'action RAML prend en charge la version 0.8 de la spécification RAML.
Procédez comme suit pour utiliser l'action RAML dans votre processus :
1. Cliquez sur , faites glisser l'action RAML sous Conception d'API jusqu'au canevas, placez le pointeur sur l'action, puis cliquez sur ou double-cliquez sur l'action. La fenêtre RAML s'ouvre.
2. Modifiez le champ Etiquette, 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 récupérer toutes les API définies dans le fichier RAML.
La liste Requête API fournit une liste des API définies dans le fichier RAML.
6. Dans la liste Requête API, sélectionnez une API.
Selon l'API sélectionnée, vous devrez peut-être fournir des détails supplémentaires.
7. Cliquez sur Terminé.
Schéma de sortie
Est-ce que cela a été utile ?