Beta-APIs

Veröffentlichte APIs und Endpunkte

In zukünftigen Versionen wird erwartet, dass sich die System-API-Funktionalität ändert. Um Versicherern bei der Verwaltung potenzieller zukünftiger Änderungen zu helfen, führt Guidewire einen Schema-Abwärtskompatibilitätsvertrag. In diesem Dokument werden die Regeln für die Änderungen festgelegt, die Guidewire in einer API-Nebenversion oder -Wartungsversion vornehmen darf, während diese Version weiterhin als abwärtskompatibel betrachtet wird. Wenden Sie sich an Ihren Guidewire-Vertreter, um eine Kopie des Schema-Abwärtskompatibilitätsvertrags anzufordern.

Der Schema-Abwärtskompatibilitätsvertrag gilt für veröffentlichte APIs und Endpunkte. Diese APIs und Endpunkte wurden als stabil zertifiziert. Standardmäßig geben Schemadokumentationsressourcen (z. B. die Swagger-Benutzeroberfläche oder die /openapi.json-Endpunkte) nur veröffentlichte APIs und Endpunkte zurück.

Beta-APIs und Beta-Endpunkte

Jede Version der Guidewire Cloud-API kann eine oder mehrere Beta-APIs oder Beta-Endpunkte enthalten. Eine Beta-API und ein Beta-Endpunkt sind eine API oder ein Endpunkt, die bzw. der noch nicht vom Schema-Abwärtskompatibilitätsvertrag abgedeckt ist. Diese APIs und Endpunkte wurden nicht als stabil zertifiziert. Sie können sich in Zukunft in einer Weise ändern, die über das hinausgeht, was vom Schema-Abwärtskompatibilitätsvertrag abgedeckt wird.

In der Basiskonfiguration gilt für die Beta-APIs und Beta-Endpunkte:

  • Sie sind nicht aktiviert.
  • Sie werden von keiner Schemadokumentationsressource (z. B. Swagger-UI oder den /openapi.json-Endpunkten) zurückgegeben.

Guidewire stellt Beta-APIs und Beta-Endpunkte bereit, um Versicherern bei der Entwicklung von System-API-Funktionen zu helfen, die in Zukunft verfügbar sein könnten. Guidewire empfiehlt jedoch, Beta-APIs und Beta-Endpunkte mit Vorsicht zu verwenden. Sie sind nicht als stabil zertifiziert und können in zukünftigen Versionen geändert werden.

WARNUNG: Guidewire unterstützt die Verwendung von Beta-APIs oder Beta-Endpunkten in der Produktion nicht.

Aktivieren von Beta-APIs und Beta-Endpunkten

Jede Beta-API oder jeder Beta-Endpunkt wird durch einen Umschalter in der Datei config.properties gesteuert. Ein Umschalter ist ein Ausdruck in config.properties, der eine Funktion aktiviert, wenn der Ausdruck auf „true“ gesetzt wird.

Bei einigen Beta-APIs und -Endpunkten ist der Umschalter in config.properties aufgeführt, jedoch auf false gesetzt. Für andere Beta-APIs und -Endpunkte gibt es in config.properties keinen Umschalter. Um Beta-APIs und -Endpunkte zu aktivieren, müssen Sie entweder den vorhandenen Umschalter auf true setzen oder einen Umschalter zu config.properties hinzufügen und ihn auf true setzen. Nachdem Sie die config.properties auf diese Weise geändert haben, müssen Sie den Server neu starten.

Als Beispiel folgende Annahme: Eine Version der Guidewire Cloud-API enthielt ein fiktives Set von Beta-Endpunkten, mit denen Versicherungskennzahlen verwaltet wurden. Für diese Endpunkte wird in config.properties der folgende Umschalter angezeigt:

feature.InsuranceMetricsApisBeta = false

Um diese Endpunkte zu aktivieren, müssen Sie die Zeile wie folgt ändern und den Server neu starten:

feature.InsuranceMetricsApisBeta = true

Identifizieren von Beta-APIs

Die Beta-APIs und -Endpunkte für diese Version, sofern vorhanden, sind im folgenden Abschnitt aufgeführt.

Sobald sie aktiviert sind, werden Beta-APIs und -Endpunkte in der Ausgabe der Endpunkte /openapi.json und /swagger.json angezeigt. Alle Beta-API-Endpunkte weisen das folgende Attribut auf:

"x-gw-beta": true

Für Beta-APIs ist das Attribut x-gw-beta auf API-Ebene aufgelistet. Das Attribut wird nicht auf der Endpunktebene angezeigt. Alle Endpunkte in einer Beta-API werden als Beta-Endpunkte betrachtet.

Für Beta-Endpunkte in einer veröffentlichten API wird das x-gw-beta-Attribut für jeden Endpunkt aufgelistet.

Das Attribut x-gw-beta wird nur für APIs und Endpunkte angezeigt, die den Beta-Status haben. Veröffentlichte APIs und veröffentlichte Endpunkte enthalten keine Auflistung von „x-gw-beta“: false.

Sobald sie aktiviert ist, erscheinen Beta-APIs auch in der Swagger-Benutzeroberfläche. Die Swagger-Benutzeroberfläche gibt jedoch nicht an, ob eine bestimmte API oder ein bestimmter Endpunkt den Beta-Status hat.

WARNUNG: Die Swagger-Benutzeroberfläche gibt keine Informationen aus proprietären Guidewire-Tags, einschließlich des x-gw-beta-Tags, wieder. Das bedeutet, dass die Swagger-Benutzeroberfläche nach dem Aktivieren der Beta-APIs nicht mehr zwischen veröffentlichten APIs und Beta-APIs unterscheidet. Guidewire empfiehlt dringend, dass Sie, wenn Sie Beta-APIs für eine bestimmte Entwicklungsinstanz aktivieren, alle Entwickler, die diese Instanz verwenden, darauf hinweisen, dass Beta-APIs aktiviert wurden. Ohne diese Warnung können andere Entwickler möglicherweise nicht zwischen veröffentlichten APIs und Beta-APIs unterscheiden.

Beta-APIs für diese Version

Diese Version enthält keine APIs, die den reinen Beta-Status aufweisen. Sie enthält auch keine Beta-Endpunkte in den veröffentlichten APIs.

Guidewire behält sich das Recht vor, neue Beta-APIs und -Endpunkte zu zukünftigen Versionen hinzuzufügen.