cms/tibi-docs
Template
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

backend & types

Browse Source
This commit is contained in:
Robin Grenzdörfer
2024-01-27 18:58:35 +00:00
parent 91bfa0864d
commit 0b4a474180
219 changed files with 5211 additions and 12325 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/md/restapi/assets.md
View File

@@ -1,27 +0,0 @@
# /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:
```yaml
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.