Schemaorganisation

Die System-APIs werden durch eine Vielzahl von Swagger- und JSON-Schemadateien definiert, die sich im Verzeichnis Project/configuration/config/Integration von Guidewire Studio befinden. Dieses Verzeichnis enthält die folgenden relevanten Unterverzeichnisse:

  • apis enthält Swagger-Dateien, die die System-APIs und die dazugehörigen Endpunkte definieren.
  • schemas enthält die Schemadefinitionen der mit den System-API-Endpunkten verknüpften Ressourcentypen.
  • mappings enthält die Zuordnungen der Schemadefinitionen zu den ClaimCenter-Entitäten.
  • updaters enthält Updaters, die die Ressourcendaten an ClaimCenter schreibbar machen.

Um ein konkretes Beispiel zu geben:

  • In apis enthält die Swagger-Datei für die Common API eine Definition für den /common/v1/activities/{activityId}-Endpunkt, dessen Stammressource Activity ist. Dieser Endpunkt unterstützt GET- und PATCH-Operationen.
  • In schemas definiert die Activity-Schemadefinition die Eigenschaften und die dazugehörenden Datentypen für die Activity-Ressource. Die Schemadefinition ist zum Definieren der Ressource erforderlich.
  • In mappings ordnet der Activity-Mapper die Activity-Schemadefinition der Activity-Entität in ClaimCenter zu. Der Mapper ist erforderlich, um GET-Operationen für die Ressource zu aktivieren.
  • In updaters legt der Activity-Aktualisierer die Activity-Ressourceneigenschaften fest, die in die Activity-Entitätsfelder in ClaimCenter geschrieben werden können. Der Updater ist erforderlich, um POST- oder PATCH-Operationen für die Ressource zu aktivieren.

Erweiterungsverzeichnisse

Die Verzeichnisse apis, schemas, mappings und updaters enthalten jeweils zwei Unterverzeichnisse, gw und ext. Das gw-Unterverzeichnis enthält die Dateien der Basiskonfiguration, die von Benutzern nicht geändert werden dürfen. Das ext-Unterverzeichnis enthält die Erweiterungsmöglichkeiten. Beim Erweitern einer API arbeiten Sie mit Dateien in den ext-Unterverzeichnissen.

Anmerkung: Auch wenn Sie die Dateien in gw-Unterverzeichnissen nicht ändern dürfen, kann es hilfreich sein, diese Dateien einzusehen, um ein besseres Verständnis für die Struktur der API-Schemas zu erhalten.

Swagger-Spezifikationssyntax

Alle Schemadateien entsprechen der Swagger 2-Spezifikation. Die Syntaxdetails finden Sie in der Spezifikation unter https://swagger.io/specification/v2/.

Die Swagger-Spezifikationsdateien in den Unterverzeichnissen für schemas, mapping und updaters liegen im JSON-Format vor, das die JSON-Schemasyntax verwendet. Details zur JSON-Schemasyntax finden Sie in der Spezifikation unter http://json-schema.org/.

Darüber hinaus finden Sie im Hinweise zur Verwendung der JSON-Schemasyntax durch Guidewire im Plugins, vordefinierte Integrationen und SOAP-APIs. Diese Dokumentation enthält Informationen zu vollständig qualifizierten Namen, die für die Dateibenennung verwendet werden und Verweise enthalten.