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.
Verwenden Sie die Aktion RAML, um auf APIs zuzugreifen und API-Aufrufe für Dienste durchführen, für die APIs mithilfe von RAML erstellt werden. Die Aktion RAML unterstützt die RAML-Spezifikationsversion 0.8.
Führen Sie die folgenden Schritte aus, um die Aktion RAML in Ihrem Workflow zu verwenden:
1. Klicken Sie auf 
, ziehen Sie die Aktion RAML unter 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 "RAML" wird geöffnet.
, ziehen Sie die Aktion RAML unter 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 "RAML" wird geöffnet.2. Bearbeiten Sie bei Bedarf die 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 alle APIs abzurufen, die in der RAML-Datei definiert sind.
Die Liste API-Anforderung enthält eine Liste von APIs, die in der RAML-Datei definiert sind.
6. Wählen Sie in der Liste API-Anforderung eine API aus.
Abhängig von der ausgewählten API müssen Sie möglicherweise weitere Details angeben.
7. Klicken Sie auf Fertig.
Ausgabeschema
