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 eine api.json Datei 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. Anmerkung:
- Die api.json finden sie unter dem Ordner assets/config für nginx und im Docker unter dem ci-Projekt mit den verschiedenen uis (wie admin-ui, b2b-ui, b2b-revisioninfo-ui, fss-ui, und so weiter)
Standardwert ohne api.json-Konfiguration
Anforderungen
Keine api.json-Datei im Projekt oder innerhalb von api.json keine Definition von Schlüsselpfadwerten, die mit dem Schlüsselpfad im api.json-Format am Ende des Dokuments übereinstimmen. Die Anwendung erhält den Standardpfadwert im System.
Ergebnis-Test
Nach dem Versuch, die Seite neu zu laden, verwendet sie den Standardpfad im System
Konfiguration für api. json
Anforderungen
- Holen Sie sich die neuesten restful api, müssen auf swagger-ui.html verweisen. Beispiel: Administrations-Controller zur Verwendung für admin-ui
- Fügen Sie die Datei api.json als Format bei verschiedenen ui-Projekten hinzu. Aktualisieren Sie den Wert mit dem neuesten Wert in swagger-ui.html, und fügen Sie api/ davor hinzu, um mit nginx config übereinzustimmen Beispiel: für admin-ui Der Pfad der Queuetabelle in api.json ist der queueTablesPath, aber anderer Wert
{
"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-info",
"securityServerPath": "api/security-server",
"systemConfigurationPath": "api/system-configuration",
"systemMessagesPath": "api/system-messages",
"ediJsonConverterPath": "api/edi-json-converter",
"serviceAdministrationPath": "api/administration/services",
"channelAdministrationPath": "api/administration/channels",
"queueTablesPath": "api/v1/queues",
"communicationRelationsPath": "api/communication-relations",
"systemErrorPath": "api/system-errors"
}
Ergebnis-Test
Nach dem Versuch, die Seite neu zu laden, überschreibt der Wert in api.json den Standardwert im System.
Liste der api.json-Dateien für UI-Projekte
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-info",
"securityServerPath": "api/security-server",
"systemConfigurationPath": "api/system-configuration",
"systemMessagesPath": "api/system-messages",
"ediJsonConverterPath": "api/edi-json-converter",
"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",
"clearingPath": "api/clearings",
"systemsPath": "api/allowed-systems",
"channelsPath": "api/channels/",
"messageFilterPath": "api/b2b-messages/filters",
"actionsPath": "api/actions",
"attributesPath": "api/attributes",
"as2Path": "api/clearing",
"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/ui/system-messages/v1",
"manualforwardsPath": "api/manualforwards",
"mLocationRoutingPath": "api/reporting-points",
"b2bNewsPath": "b2bNews",
};
FSS UI
{
"certificatesPath": "api/v1/certificates",
"systemConfigurationPath": "api/v1/conf",
"clientsPath": "api/v1/clients",
"rulesPath": "api/v1/rules",
"exportPath": "api/v1/export",
"configPath": "api/v1/conf"
};
B2B Revision Info UI
{
"revisionManagerPath": "api/revisionmanager",
"systemMessagesPath": "api/ui/system-messages/v1",
"errorsPath": "api/ui/errors/v2"
};
Index Management UI
{
"serverInfoPath": "api/ui/server-info/v1",
"systemMessagesPath": "api/ui/system-messages/v1",
"systemConfigurationPath": "api/ui/system-configuration/v1",
"searchPath": "api/indexmanagement/search",
"indexPath": "api/indexmanagement/index",
"documentPath": "api/indexmanagement/document"
};
User Messages UI
{
"systemMessagesPath": "b2b-user-messages/system-messages",
"serverInfoPath": "api/server-infos",
"securityServerPath": "api/security-server",
"ediJsonConverterPath": "api/ui/edi-json-converter/v1",
};
Portal UI
{
"serverInfoPath": "api/server-infos",
"securityServerPath": "api/security-server",
"systemConfigurationPath": "api/system-configurations",
"systemMessagesPath": "api/ui/system-messages/v1",
"ediJsonConverterPath": "api/ui/edi-json-converter/v1",
"systemErrorPath": "api/ui/system-errors/v1"
};