tibi-starter/docs/md/restapi/assets.md
2024-02-13 16:36:09 +00:00

1.4 KiB

/assets

Die /assets-API ist dazu gedacht, den Zugriff auf bestimmte Ordnerpfade zu ermöglichen, die direkt über den Tibi-Server erreichbar sind. Diese Pfade werden in der Konfigurationsdatei (config.yml) definiert und relativ zu dieser Datei interpretiert. Jeder dieser Pfade wird durch einen eindeutigen Namen identifiziert, der in der URL verwendet wird.

URL-Struktur

Die Struktur der URL für den Zugriff auf die Assets ist wie folgt:

  • TIBI-SERVER-URL/api/v1//NAMESPACE//assets/NAME/

Hierbei steht NAME für den in der Konfigurationsdatei festgelegten Namen für den Pfad. Wenn beispielsweise ein Pfad mit dem Namen dist definiert ist, der auf den Ordner ../frontend/dist relativ zur config.yml zeigt, würde die entsprechende URL so aussehen:

  • TIBI-SERVER-URL/api/v1//NAMESPACE//assets/dist/

Zugriffsmethode

Über die /assets-API ist ausschließlich ein unbeschränkter Lesezugriff (GET-Methode) möglich. Dies bedeutet, dass Sie über diese API Dateien aus den definierten Pfaden abrufen können, aber keine Änderungen vornehmen oder Dateien hochladen können. Konfigurationsbeispiel

In der config.yml könnten Sie einen Asset-Pfad wie folgt definieren:

name: _dist_
path: ../frontend/_dist_

Dies würde den Zugriff auf Dateien im Ordner ../frontend/dist relativ zur config.yml über die URL TIBI-SERVER-URL/api/v1//NAMESPACE//assets/dist/ ermöglichen.