Deutsch

Hintergrund

Voraussetzungen

Aufruf der Funktion

Deutsch

Hintergrund

Im Sage AppDesigner kann man sich Sage API-Endpunkte erstellen (entsprechende Lizenz vorausgesetzt).

Es stellt sich die Frage , wie man diese Endpunkte möglichst elegant direkt aus dem AppDesigner heraus dokumentieren kann.

Es springt die Funktion "API-Dokumentation erzeugen" sofort ins Auge , die aber gewisse Lizenz- und Setup-Voraussetzungen mit sich bringt.

Voraussetzungen

Wesentliche Voraussetzung ist eine Sage Entwicklerlizenz. Darüber hinaus muss dass SDK Entwickler-Setup von Sage mit nachfolgenden Optionen installiert werden.

⚠️Dieses Setup wird in der aktuellsten Version von Sage grundsätzlich im Anschluss an die jährliche Sage Developer Konferenz für Partner veröffentlicht , die entsprechende Verträge mit Sage abgeschlossen haben.

Aufruf der Funktion

Sobald alle Voraussetzungen erfüllt sind , kann man die Funktion "API-Dokumentation erzeugen" auf der entsprechenden AppDesigner-Lösung starten.

Der erste Punkt "OpenAPI Dokumentation erzeugen" erstellt eine Datei namens "ApiDoc.json". Standardmäßig hat diese Datei eine proprietäre Struktur. Man kann diese Datei daher nicht direkt in Swagger, Postman oder anderen gängigen API-Lifecycle-Tools verwenden. Die Datei enthält jedoch alle erforderlichen architektonischen Daten, wie zum Beispiel Felddatentypen, ob Felder Pflichtfelder sind und ob sie schreibgeschützt sind. Die Datei eignet sich somit als gute Basis für eine Dokumentation!

Das Erstellen der C# Client Klassen ist eine nützliche Hilfestellung und basiert auf diversen Sage Vorlagen.

Selbstverständlich hängt es vom Projekt ab , inwieweit dies sinnvoll ist und inwieweit eine Nacharbeitung des Quellcodes notwendig ist.

Grundsätzlich ist die Sage API nutzbar , sobald die Endpunkte im Sage Applikationsserver veröffentlicht wurden - ein Neustart des Sage Applikationsservers ist dazu zwingend notwendig!