API-Module aktualisieren

Um API-Module zu aktualisieren, müssen Sie sie mit einem Schema vergleichen. Führen Sie hierzu die folgenden Schritte aus:

1. Wählen Sie im Tosca Commander eines der folgenden Elemente aus:

   • Einen Modulordner, der API-Module enthält.

   • Einen Komponenten-Ordner, der API-Module und Testfälle enthält.

   • Das Projektwurzelelement.

2. Navigieren Sie zum Menü API Testing.

3. Klicken Sie im Abschnitt Message auf Update Modules oder wählen Sie eine der folgenden Optionen aus dem Aufklappmenü:

   • Wählen Sie From URI, um die neue Schema-Definition aus einem URI aufzuzeichnen. Dies ist die Standardoption.

   • Wählen Sie From File, um die neue Schema-Definition aus einer Datei aufzuzeichnen.

4. Geben Sie im Folgedialog das Schema an:

   • From URI: Geben Sie den URI des Serviceschemas in das Feld URI ein.

   • From File: Geben Sie den Dateipfad der Schemadatei ein oder klicken Sie auf Browse, um nach ihr zu suchen.

5. Wählen Sie unter Module Identification aus, wie das Modul, das Sie aktualisieren möchten, identifiziert werden soll:

   • Use Method and Resource zur Verwendung der Methode und Ressource des Moduls.

   • Use operationId/description in schema, d. h. die Operations-ID oder die Beschreibung, die Ihr Swagger oder RAML enthält.

6. Wählen Sie unter New Modules die Option Create new Modules in NEW Modules folder, wenn das System bei einer Schemaänderung neue Module hinzufügen soll.

7. Wählen Sie unter Update Areas aus, welche Elemente Sie aktualisieren möchten:

   • Wählen Sie Request Modules, Response Modules oder beides, um die Module und alle darin enthaltenen Elemente zu aktualisieren.

   • Um nur bestimmte Modulelemente zu aktualisieren, wählen Sie eines oder mehrere von ihnen aus: Resources, Params, Payloads, Status Codes.

     Wenn Sie für die Modulidentifikation Use Method and Resource gewählt haben, ist die Option Resources in diesem Schritt nicht verfügbar.

8. Aktivieren oder deaktivieren Sie unter Module Attributes die folgenden Kontrollkästchen:

   • Create Module Attributes for new Modules. Diese Option ist nur verfügbar, wenn Sie Create new Modules in NEW Modules folder ausgewählt haben.

   • Create Module Attributes for new Nodes or Parameters.

9. Wenn Sie From URI ausgewählt haben, klicken Sie optional auf Advanced, um die Anmeldedaten der Basic Authentication oder Einzelheiten zum Proxy einzugeben.

10. Klicken Sie auf OK, um Ihre Module zu aktualisieren.

Die API Engine führt die Aktualisierung basierend auf Ihren Angaben im Dialog Update durch und informiert Sie unter Update Log Summary über den Vorgang.