API-Endpunkt für eine Applikation erstellen

Schritt-für-Schritt

1. Öffnen Sie die Applikation "Aufgabenverwaltung".

   Klicken Sie auf (Neuen Endpunkt erstellen).

   Damit der Bereich "API-Endpunkte" angezeigt wird, müssen Sie im Hauptmenü unter "Ansicht" das Kontrollkästchen "API-Endpunkte" aktivieren Ansicht "API-Endpunkte" aktivieren.

   

   Sie gelangen auf den Dialog-Schritt "Allgemein".

   

2. Erfassen Sie einen Namen und eine Beschreibung für den Endpunkt.

   Der Name muss eindeutig sein, mindestens aus zwei Zeichen bestehen und mit einem Buchstaben beginnen. Erlaubt sind dabei nur alphanumerische Zeichen, Bindestriche, Unterstriche und Punkte.

   Die in den Dialogen erfassten Texte fließen in die Swagger-Dokumentation ein. Daher ist es für Sie und für einen potenziellen Dienstleister sehr hilfreich, wenn Sie sprechende Bezeichnungen wählen und einer Namenskonvention folgen.

3. Klicken Sie auf "Datengruppen-Endpunkt".

4. Klicken Sie auf "Weiter".

   Sie gelangen auf den Dialog-Schritt "Datengruppenauswahl".

5. Wählen Sie im Auswahlfeld "Aktion" den Wert "Mehrere Datensätze lesen" aus.

6. Wählen Sie im Auswahlfeld "Datengruppe" den Wert "Team" aus.

   

Schritt-für-Schritt

1. Klicken Sie auf das - Icon.

   Das Dialogfenster "Datenfelder hinzufügen" wird angezeigt.

   

2. Deaktivieren Sie das Kontrollkästchen "(PK) (S) (ID) <string>

3. Aktivieren Sie die folgenden Kontrollkästchen:

   • Beschreibung <text>

   • Titel <string>

   • Teamleitung - Voller Name <string>

4. Klicken Sie auf "OK".

   Sie gelangen zurück auf den Dialog-Schritt "Datengruppenauswahl".

   Die zuvor ausgewählten Datenfelder werden im Bereich "Rückgabewerte der Anfrage" angezeigt.

   

   Für eine bessere Lesbarkeit der Rückgabewerte und der Swagger-Dokumentation empfiehlt es sich, die Rückgabewerte umzubenennen.

5. Markieren Sie im Bereich "Rückgabewerte der Anfrage" einen Rückgabewert.

6. Erfassen Sie im rechten Bereich einen Namen und eine Beschreibung für den Rückgabewert.

   

   In unserem Beispiel verwenden wir die "Camel-Schreibweise". Der erste Teil des Namens gibt dabei die Applikation bzw. die Ressource an.

   • teamDescription

   • teamTitle

   • teamFullNameTeamLeader

7. Nehmen Sie die Umbenennungen für alle Rückgabewerte vor.

8. Klicken Sie auf "Weiter".

   Sie gelangen in den Dialog "Pfad-Parameter".

Die Angabe eines Pfad-Parameters ist Pflicht. Wir verwenden einen statischen Parameter. Wir verwenden den statischen Pfadparameter zur Angabe der Ressource.

Schritt-für-Schritt

1. Klicken Sie auf das - Icon.

2. Klicken Sie auf "Statisch".

   

3. Erfassen Sie den Namen "taskmanagementTeams" und eine sprechende Beschreibung.

   

4. Klicken Sie auf "Weiter".

   Sie gelangen in den Dialog-Schritt "Query-Parameter".

Im Dialogschritt Query-Parameter sind keine Angaben bzw. Abfragen erforderlich, da wir alle Teams ermitteln wollen.

Klicken Sie auf "Weiter".

Sie gelangen in den Dialog-Schritt "Filter und Sortierung".

Im Dialog-Schritt "Filter und Sortierung" legen wir die Sortierung der Rückgabewerte fest. Sie soll anhand des Team-Titels erfolgen.

Schritt-für-Schritt

1. Klicken Sie auf das - Icon.

   

2. Wählen Sie "Team > Titel <string>" aus.

   

   Die ausgewählte Sortierung wird angezeigt.

3. Entfernen Sie - falls vorhanden - andere Sortierungen.

   

4. Klicken Sie auf "Fertigstellen".

   Der neu angelegte Endpunkt wird im Bereich "API-Endpunkte" angezeigt.

5. Klicken Sie auf das - Icon (Applikation vollständig veröffentlichen).

   

In diesem Schritt erteilen wir dem Benutzer David Winter das Recht zu, den zuvor erstellten Endpunkt benutzen zu dürfen.

Im darauf folgenden Schritt weisen wir dem Benutzer David Winter den API-Key zu, so dass er dann über alle erforderlichen Rechte verfügt, um den API-Endpunkt nutzen zu können.

Schritt-für-Schritt

1. Öffnen Sie den Eigenschaften-Dialog der Applikation "Aufgabenverwaltung".

   Markieren Sie hierfür die Applikation und drücken "ENTER".

   Oder

   Markieren Sie die Applikation und klicken Sie auf die rechte Maustaste.

   Klicken Sie auf "Eigenschaften" im Kontextmenü.

   Der Dialog "Eigenschaften - Applikation" wird angezeigt.

2. Wechseln Sie auf die Registerkarte "Berechtigungen".

3. Wechseln Sie im linken Bereich auf die Registerkarte "API-Endpunkte.

   Markieren Sie den Endpunkt "/taskmanagementTeams".

   

4. Klicken Sie auf "Hinzufügen".

   Sie gelangen in den Dialog "Rechteinhaber hinzufügen".

   

5. Wählen Sie den Benutzer "David Winter" aus.

6. Klicken Sie auf "OK".

   Der Benutzer "David Winter" wird angezeigt.

   Er verfügt über das Recht "Endpunkt benutzen".

   

   Klicken Sie auf "OK".

   Sie gelangen zurück in die Applikation.

7. Klicken Sie auf das - Icon (Applikation vollständig veröffentlichen).

Schritt-für-Schritt

1. Starten Sie das Modul "Integration".

2. Klicken Sie auf "Application-API" > "API-Keys".

3. Klicken Sie mit der rechten Maustaste auf "API-Keys ohne Rolle".

   Ein Kontextmenü wird angezeigt.

4. Klicken Sie auf "Neuen API-Key erstellen".

   

   Das Dialogfenster "Neuen API-Key erstellen" wird angezeigt.

   

5. Erfassen Sie im Feld "Name" einen sprechenden Namen für den API-Key.

6. Wählen Sie im Auswahlfeld "Benutzer" den Benutzer "David Winter" aus.

7. Aktivieren Sie das Kontrollkästchen "Aufgabenplanung".

   Der API-Endpunkt wird dadurch automatisch mitaktiviert.

   

8. Klicken Sie auf "OK".

   Der API-Key-Eintrag wird unterhalb von "API-Keys ohne Rolle" angezeigt.

   

Schritt-für-Schritt

1. Markieren Sie den API-Key, den Sie erstellt haben.

2. Drücken Sie die rechte Maustaste.

   Ein Kontextmenü wird angezeigt.

   

3. Klicken Sie auf API-Key kopieren.

   Der API-Key befindet sich nun in der Zwischenablage.

   Es bietet sich an, den API-Key beispielsweise in Notepad einzufügen.

Schritt-für-Schritt

1. Starten Sie das Modul "Integration".

2. Klicken Sie auf "Application-API" > "API-Endpunkte".

3. Markieren Sie die Applikation, für die Sie die Swagger-Dokumentation erstellen möchten.

4. Führen Sie einen Rechtsklick aus.

   Ein Kontextmenü wird angezeigt.

   

5. Klicken Sie auf "Swagger-Dokumentation erstellen".

6. Speichern Sie die Swagger-Dokumentation.

   Die Swagger-Dokumentation wird im Format "yaml" abgelegt ("taskmanagement.yml").

Schritt-für-Schritt

1. Starten Sie Postman.

2. Klicken Sie im linken Navigationsbereich auf den Menüpunkt "APIs".

   

3. Klicken Sie auf "Import".

   

   Ein Import-Dialog wird angezeigt.

4. Wählen Sie die zuvor gesicherte .yml-Datei aus ("taskmanagement.yml").

5. Klicken Sie auf "Import".

   

   Ein Dialog wird angezeigt, der den Import bestätigt.

   Die Intrexx-API wird angezeigt.

   

Schritt-für-Schritt

1. Klicken Sie auf das Verzeichnis mit dem Namen der importierten Swagger-Dokumentation.

   

2. Klicken Sie auf die Registerkarte "Authorization".

3. Wählen Sie in der Auswahlliste "Type" den Wert "API Key" aus ().

4. Tragen Sie im Eingabefeld "Key" den Wert "X-API-KEY" ein ().

5. Hinterlegen Sie im Eingabefeld "Value" den API-Key, den Sie aus Intrexx kopiert haben (siehe Schritt 8 - API-Key kopieren)().

6. Wählen Sie im Auswahlfeld "Add to" den Wert "Header" aus ().

7. Speichern Sie Ihre Angaben.

   

Schritt-für-Schritt

1. Klicken Sie auf den API-Endpunkt "Get-all-teams" ().

2. Deaktivieren Sie auf der Registerkarte "Params" die Query Params KEYs (). (Die entsprechenden Einstellungen werden durch die Swagger-Dokumentation gesteuert.)

   

3. Klicken Sie auf "Send".

   Die von Ihnen definierten Rückgabewerte werden unter "Body" angezeigt.

   

   Anzeige auf der Registerkarte "Visualize"

   Postman bietet über die Registerkarte "Visualize" die Möglichkeit, die übermittelten JSON-Daten im HTML-Format darzustellen.

   

   Hierzu müssen Sie auf der Registerkarte "Tests" einen entsprechenden Code hinterlegen (). Detaillierte Informationen hierzu finden Sie unter folgendem Link: Postman Learning Center - Visualizing responses.

   Wenn Sie anschließend den Request noch einmal ausführen und auf die Registerkarte "Visualize" () wechseln, werden die Daten so dargestellt, wie sie gegebenenfalls auch in einer App oder in einer Cloud-Lösung angezeigt werden.

   

   Unten finden Sie den Code, der in der Registerkarte "Tests" verwendet wurde.

   Beispiel-Code

   pm.test("Status code is 200 and Present in Tabular form", function () {
       pm.response.to.have.status(200);
       let template = `
   	<style type="text/css">
           .ixtable {font-size:14px;color:#ffffff;width:100%;border-width: 1px;border-color: #00a3c7;border-collapse: collapse;}
           .ixtable th {color: #ffffff;font-size:16px;background-color:#00a3c7;border-width: 1px;padding: 8px;border-style: solid;border-color: #87ceeb;text-align:left;}
           .ixtable tr {color:#2a2a2a;background-color:#ffffff;}
           .ixtable td {font-size:14px;border-width: 1px;padding: 8px;border-style: solid;border-color: #87ceeb;}
           .ixtable tr:hover {background-color:#e0ffff;}
       </style>
       <div>
           <table class="ixtable" border="1">
               <tr>
                   <th>Name</th>
                   <th>Teamleader</th>
                   <th>Beschreibung</th>
               </tr>
               {{#each .}}
               <tr>
                   <td>{{teamTitle}}</td>
                   <td>{{teamFullNameTeamLeader}}</td>
                   <td>{{teamDescription}}</td>
               </tr>
               {{/each}}
           </table>
       </div>`;
       let response = pm.response.json();
       pm.visualizer.set(template, response.data);
   });