Testen von Anforderungen und Antworten

Entwickler, die mit System-APIs arbeiten, verwenden in der Regel ein Tool, das Anforderungen senden und Antworten innerhalb eines akzeptablen Zeitraums abrufen kann. Guidewire empfiehlt dazu Postman. Dieses Tool bietet folgende Möglichkeiten:

  • API-Aufrufe speichern, einschließlich Header und Nutzdaten
  • Sammlungen von Aufrufen speichern
  • Automatisches Erstellen einer Sammlung von Aufrufen für die Pfade eines Schemas durch Importieren der Swagger-Schemadatei
  • Gemeinsame Nutzung von Sammlungen mit anderen Entwicklern in Ihrem Team

Weitere Informationen und zum Herunterladen des Tools finden Sie unter https://www.postman.com/.

Hinweis: Die Swagger-Benutzeroberfläche kann auch Anforderungen an eine funktionierende API senden und Antworten anzeigen. Die System-APIs sind jedoch enorm robust, und die Leistungszeit für das Abrufen von Antworten auf Anforderungen kann unannehmbar lang sein. Guidewire empfiehlt, die Swagger-Benutzeroberfläche nur zum Anzeigen der System-API-Dokumentation zu verwenden.

Lernprogramm: Einrichten Ihrer Postman-Umgebung

Die System-API-Dokumentation enthält eine Reihe von Lernprogrammen, die Sie durch Beispiele für das Senden von Anforderungen und das Überprüfen der Antworten führen. Alle diese Lernprogramme setzen die folgende Basisumgebung voraus:

  • Eine auf Ihrem Computer installierte Standardinstanz von ClaimCenter, die nur den Demo-Beispieldatensatz enthält.
  • Eine Instanz von Postman.

Dieses Tutorial führt Sie durch den Einrichtungsprozess dieser Umgebung.

Hinweis: Wenn Ihre Instanz von ClaimCenter auf einem anderen Computer installiert ist, müssen Sie die in den Lernprogrammen angegebenen Endpunkt-URLs anpassen. Wenn Sie zusätzlich zu den Demo-Beispieldaten Daten erstellen, können Ihre Antworten ebenfalls von den in den Lernprogrammen beschriebenen abweichen.

Schritte des Lernprogramms

  1. Installieren Sie Postman. (Weitere Informationen finden Sie unter https://www.postman.com/.)
  2. Starten Sie ClaimCenter und laden Sie den Demo-Beispieldatensatz.

Sie können Ihre Umgebung testen, indem Sie Ihre erste Postman-Anfrage senden.

  1. Öffnen Sie Postman.
  2. Starten Sie in Postman eine neue Anforderung, indem Sie auf das + rechts neben der Registerkarte Launchpad klicken.
  3. Stellen Sie sicher, dass unter der Bezeichnung Untitled Request GET ausgewählt ist. (Dies ist die Standardoperation.)
  4. Geben Sie im Feld Enter request URL die folgende URL ein: http://localhost:8080/cc/rest/common/v1/activities
  5. Jede Registerkarte in Postman erfordert Autorisierungsinformationen, um die Anforderung auszuführen. So stellen Sie ausreichende Autorisierungsinformationen bereit:
    1. Klicken Sie auf die Registerkarte Authorization.
    2. Wählen Sie in der Dropdown-Liste Type die Option Basic Auth.
    3. Geben Sie im Feld Username den Wert aapplegate ein.
    4. Geben Sie im Feld Password den Wert gw ein.
  6. Klicken Sie rechts vom Anforderungsfeld auf die Schaltfläche Senden.

Ihre Arbeit überprüfen

Sobald eine Antwort eingegangen ist, werden ihre Nutzdaten im unteren Bereich der Postman-Oberfläche angezeigt. Wenn Ihre Umgebung korrekt eingerichtet wurde, lauten die ersten Zeilen der Antwort-Nutzdaten:

{
    "count": 25,
    "data": [
        {
        "attributes": {
            "activityPattern": "contact_claimant",
            "assignedGroup": {
                "displayName": "Auto1 - TeamA",
                "id": "demo_sample:31"
            },
            "assignedUser": {
                "displayName": "Andy Applegate",
                "id": "demo_sample:1"
            },

Fehlersuche: Keine Antwort

Anforderungen können nur an laufende Anwendungen gesendet werden. Alle Lernprogramme in dieser Dokumentation erfordern, dass ClaimCenter ausgeführt wird. Wenn Sie eine Anforderung senden, wenn die Anwendung nicht ausgeführt wird, wird ein Fehler ähnlich dem folgenden angezeigt:

Could not get any response

There was an error connecting to http://localhost:8080/cc/rest/common/v1/activities.

Fehlersuche: NotFoundException

Sofern nicht anders angegeben, verwenden alle Lernprogramme die Basisauthentifizierung und den Benutzer aapplegate. Wenn eine NotFoundException wie im folgenden Beispiel auftritt, kann dies darauf zurückzuführen sein, dass für diesen Benutzer keine richtigen Authentifizierungsinformationen bereitgestellt wurden.

"status": 404,
"errorCode": "gw.api.rest.exceptions.NotFoundException",
"userMessage": "No resource was found at path /common/v1/activities/xc:20"