Konfiguration api.json

Einführung

Derzeit haben wir in unserem Front-End-Projekt Standardpfade für Restful APIs konfiguriert. Um jedoch flexibler für das Projekt zu sein, stellen wir die api.json Dateien als Option in Nginx- und Docker-Instanzen zur Verfügung um diese Pfade zu verändern. Alle Werte in der api.json überschreiben den Standardwert.

  • Bei nginx-Installationen befindet sich die api.json im Ordner /assets/config
  • Bei Docker-Installationen befindet sich die api.json im ci-Projekt unter den verschiedenen UIs (wie admin-ui, b2b-ui, b2b-revisioninfo-ui, fss-ui, etc.)

Standardwert ohne api.json-Konfiguration

Befindet sich keine api.json-Datei im Projekt oder enthält diese keine Definition von Schlüsselpfaden, die mit dem Format am Ende dieser Dokumentation übereinstimmen, erhält die B2B den Standardpfadwert aus dem System.

Ergebnis-Test

Nach dem Neuladen einer Seite der B2B, wird der im System hinterlegte Standardpfad genutzt.

Konfiguration der api.json

Die aktuellen Standardwerte für die api.json finden Sie am Ende dieser Dokumentation.

  1. Legen Sie Einträge mit den gewünschten Pfadnamen an und überschreiben Sie den Pfad.
  2. Fügen Sie die api.json der jeweiligen UI-Anwendung hinzu.

Beispiel anhand Admin-UI: Der Pfadname der Queuetabelle ist queueTablesPath. Dieser Pfad wird in der api.json wie folgt überschrieben:

{
  "queueTablesPath": "api/v1/queues"
}

Ergebnis-Test

Nach dem Neuladen einer Seite der B2B, überschreibt der Wert aus der api.json den Standardwert im System und das Front-End versucht den neuen Pfad aufzurufen.

In Swagger-UI finden Sie ebenfalls alle Pfade, allerdings ohne das vorangestellte api/.

Liste der api.json-Dateien der UI-Projekte

Portal UI

{
  "serverInfoPath": "api/server-infos",
  "securityServerPath": "api/security-server",
  "systemConfigurationPath": "api/system-configurations",
  "systemMessagesPath": "api/b2b-user-messages/system-messages",
  "ediJsonConverterPath": "api/ui/edi-json-converter/v1",
  "systemErrorPath": "api/ui/system-errors/v1"
}

Admin UI

{
  "actionAdministrationPath": "api/administration/actions",
  "extensionAdministrationPath": "api/administration/extensions",
  "contentAdministrationPath": "api/administration/contents",
  "revisionManagerPath": "api/revisionmanager",
  "globalPropertiesPath": "api/administration/global-properties",
  "customizingPath": "api/administration/customizing",
  "locktableEntriesPath": "api/locktable-entries",
  "serverInfoPath": "api/server-infos",
  "securityServerPath": "api/security-server",
  "systemConfigurationPath": "api/system-configurations",
  "systemMessagesPath": "api/b2b-user-messages/system-messages",
  "ediJsonConverterPath": "api/ui/edi-json-converter/v1",
  "serviceAdministrationPath": "api/administration/services",
  "channelAdministrationPath": "api/administration/channels",
  "queueTablesPath": "api/queues",
  "communicationRelationsPath": "api/communication-relations",
  "systemErrorPath": "api/system-errors"
}

B2B UI

{
  "messageMonitorPath": "api/b2b-messages",
  "globalPropertiesPath": "api/administration/global-properties",
  "clearingPath": "api/clearings",
  "systemsPath": "api/allowed-systems",
  "channelsPath": "api/channels/",
  "messageFilterPath": "api/b2b-messages/filters",
  "actionsPath": "api/actions",
  "attributesPath": "api/attributes",
  "as2Path": "api/as2messages",
  "errorsPath": "api/errors",
  "workListPath": "api/worklists",
  "systemSwitchPath": "api/switch-messages",
  "statisticsPath": "api/statistics",
  "marketPartnerManagementPath": "api/marketpartner-relations",
  "serverInfoPath": "api/server-infos",
  "securityServerPath": "api/security-server",
  "systemConfigurationPath": "api/system-configurations",
  "systemMessagesPath": "api/b2b-user-messages/system-messages",
  "manualforwardsPath": "api/manualforwards",
  "mLocationRoutingPath": "api/reporting-points",
  "b2bNewsPath": "b2bNews",
  "revisionManagerPath": "api/revisionmanager"
}

FSS UI

{
  "certificatesPath": "api/v1/certificates",
  "serviceAdministrationPath": "api/administration/services",
  "systemConfigurationPath": "api/v1/conf",
  "clientsPath": "api/v1/clients",
  "rulesPath": "api/v1/rules",
  "exportPath": "api/v1/export",
  "configPath": "api/v1/conf",
  "fssInfoPath": "api/v1/versioninfo",
  "systemMessagesPath": "api/b2b-user-messages/system-messages",
  "revisionPath": "api/b2b-revision/revisionmanager",
  "syncInfoPath": "api/mp-certificate-importer/sync-info",
  "syncedCertificatesPath": "api/mp-certificate-importer/synced-certificates"
}

B2B Revision Info UI

{
  "revisionManagerPath": "api/revisionmanager",
  "systemMessagesPath": "api/b2b-user-messages/system-messages",
  "errorsPath": "api/ui/errors/v2"
}

Index Management UI

{
  "serverInfoPath": "api/server-infos",
  "systemMessagesPath": "api/b2b-user-messages/system-messages",
  "systemConfigurationPath": "api/system-configurations",
  "searchPath": "api/indexmanagement/search",
  "indexPath": "api/indexmanagement/index",
  "documentPath": "api/indexmanagement/document"
}

User Messages UI

{
  "systemMessagesPath": "api/b2b-user-messages/system-messages",
  "serverInfoPath": "api/server-infos",
  "securityServerPath": "api/security-server",
  "ediJsonConverterPath": "api/ui/edi-json-converter/v1"
}
View Me   Edit Me