Entwicklungstipp: Verwendung öffentlicher Methoden

Andreas-Knoor
Crownpeak Employee
Crownpeak Employee
3 0 171

Access-API

Bei der Entwicklung von Skripten oder Modulen wird man immer die FirstSpirit Access-API verwenden.

Die API beschreibt alle öffentlichen Methoden der FirstSpirit-API.

Die Dokumentation der API ist hier verfügbar:

Dos and Don'ts

Die Java-Library, die bei der Entwicklung verwendet werden muss ist "fs-access.jar".

Dort sind alle freigegeben API-Interfaces enthalten. Die Verwendung dieser Library garantiert, dass man immer auf den stabilen öffentlichen Klassen und Methoden arbeitet. Bei eine Migration auf eine zukünftige FirstSpirit-Version hat man mit diesem Vorgehen die minimalsten Aufwände.

Was man nicht tun sollte:

Es sollte niemals das komplette Server-Jar-File (fs-server.jar) in die Entwicklungsumgebung integriert werden. Auch wenn die Versuchung anfangs groß erscheint, weil man ja "viel mehr" Klassen im Angebot hat: Durch diesen Ansatz merkt man bei der Entwicklung in einer IDE nicht, dass man den "stabilen" Bereich der API verlässt.

Die Folge: Updates auf neuen FirstSpirit-Version können mit massiven Umstellungsarbeiten verbunden sein, was weder für den Entwickler noch für den Kunden gut ist.

Dieser Fehler sollte auf jeden Fall vermieden werden!

Falls im "fs-access.jar" Dinge fehlen sollten, die für die Umsetzung einer bestimmten Funktion zwingend notwendig sind, dann bitte einen Feature-Request im erstellen.