RAML
Die RESTful API Modeling Language (RAML) ist eine YAML-basierte Sprache, die die RESTful-APIs beschreibt. Die RAML bietet auch Funktionen zum umfassenden Dokumentieren einer RESTful-API und solche, die es Dokumentationswerkzeugen ermöglichen, die Benutzerdokumentation zu extrahieren und dann in visuelle Formate wie PDF, HTML usw. zu übersetzen.
 |
RAML-Spezifikation Version 0.8 wird unterstützt.
|
Verwenden Sie diese Aktion, um auf die APIs zuzugreifen und API-Aufrufe an den Dienst zu senden, dessen APIs mit RAML erstellt werden.
Aktion "RAML" verwenden
Um diese Aktion in einem Workflow verwenden zu können, müssen Sie sie mit ThingWorx Flow verbinden. Gehen Sie zum Herstellen einer Verbindung mit dem Fluss wie folgt vor:
1. Klicken Sie auf 
, ziehen Sie die Aktion RAML unter dem Dienstprogramm API-Design in den Zeichenbereich, zeigen Sie mit der Maus auf die Aktion, und klicken Sie dann auf 
. Oder: Doppelklicken Sie auf die Aktion. Das Fenster für die Aktion "RAML" wird geöffnet.
, ziehen Sie die Aktion RAML unter dem Dienstprogramm API-Design in den Zeichenbereich, zeigen Sie mit der Maus auf die Aktion, und klicken Sie dann auf . Oder: Doppelklicken Sie auf die Aktion. Das Fenster für die Aktion "RAML" wird geöffnet.2. Bearbeiten Sie bei Bedarf den Namen der Beschriftung. Standardmäßig ist der Beschriftungsname mit dem Aktionsnamen identisch.
3. Geben Sie im Feld Stammdatei-URL die URL zum Abrufen der ZIP-Datei ein, die die RAML-Stammdatei und ihre Abhängigkeiten enthält.
4. Geben Sie im Feld Stammdateiname den Namen der abzurufenden RAML-Stammdatei ein.
5. Klicken Sie auf Abrufen, um die zugrunde liegende API zu konfigurieren.
6. Klicken Sie auf Fertig.
Ausgabeschema
Die Aktion "RAML" gibt ein Ausgabeschema wie in der folgenden Abbildung dargestellt zurück:
