FirstSpirit REST API, 0.0.23
Dokumentation

FirstSpirit REST API: Installation & Konfiguration

Der FirstSpirit-REST-Service ist eine Webanwendung, die eine REST-Schnittstelle bereitstellt. Das Modul befindet sich derzeit in aktiver Entwicklung und bietet Zugriff auf verschiedene Kernfunktionen.

FirstSpirit würde sich über Ihr Feedback zu den bestehenden Endpunkten und den zurückgegebenen JSON-Daten freuen.

Da sich das Modul noch im Alpha-Stadium befindet, sollten Sie Folgendes beachten:
  • In seiner derzeitigen Form sollte das Modul ausschließlich zu Test- und Entwicklungszwecken verwendet werden.
  • Verwenden Sie das Modul nicht auf einem Produktionsserver.
  • Die Alpha-Version wurde noch keinen Sicherheitstests unterzogen. Setzen Sie sie nicht öffentlichen Netzwerken aus.

Installation

Um das Modul zu installieren:

  • Laden Sie die neueste Version aus Artifactory herunter.
  • Erstellen Sie eine Datei mit dem Namen fs-rest-service.properties im Verzeichnis lib von Tomcat.

Die Datei fs-rest-service.properties muss wie hier beschrieben weiter konfiguriert werden.

  • Installieren Sie das Modul über den ServerManager.
    → Es wird automatisch eine neue Webanwendung „/rest“ erstellt.
  • Wählen Sie den richtigen Webserver aus und deployen Sie den Dienst.

Konfiguration

Die Datei fs-rest-service.properties erfordert die folgende Mindestkonfiguration:

fs.rest.host=localhost
fs.rest.port=1088
fs.rest.mode=SOCKET

Passen Sie den Hostnamen und den Port an Ihre lokale Umgebung an. Die Eigenschaft mode akzeptiert entweder SOCKET oder HTTP.

Wenn der REST-Dienst als Teil einer Webanwendung betrieben wird, müssen möglicherweise auch die CORS-Origins konfiguriert werden:

fs.rest.cors.allowedOriginPatterns=http://localhost:*

Um Rate Limiting zu aktivieren, fügen Sie die folgenden Eigenschaften zur fs-rest-service.properties hinzu:

fs.rest.rateLimit.enabled=true
fs.rest.rateLimit.requestsPerWindow=300
fs.rest.rateLimit.windowSeconds=60
fs.rest.rateLimit.warnThreshold=0.8

Seiteninhalte