ARUNOX Framework

API-Dokumentation: Multi-Source

Diese Seite beschreibt die Nutzung der API, um mehrere PHP-Dateien als gesammelte Dokumentation abzurufen. Die API unterstützt außerdem die rekursive Suche in Verzeichnissen.

Einleitung

Die API ermöglicht es, mehrere PHP-Dateien gleichzeitig abzurufen und deren Inhalte kombiniert darzustellen. Durch die rekursive Suche können alle Dateien in einem Verzeichnis automatisch geladen werden.

Endpunkt

Die API ist unter folgendem Endpunkt erreichbar:

https://documentation.arunox.dev/api.php

Parameter

Die API akzeptiert folgende Parameter:

Parameter Beschreibung Beispiel
files Liste der gewünschten Dateien oder Verzeichnisse (relativ zu FRAMEWORK_ROOT), getrennt durch Kommas. Der .php-Suffix wird automatisch ergänzt. Verzeichnisse können mit /* rekursiv durchsucht werden. library/ARUNOX/Database/*,library/ARUNOX/Config

Beispielanfragen

1. Einzelne Dateien abrufen:

https://documentation.arunox.dev/api.php?files=library/ARUNOX/Database,library/ARUNOX/Config

2. Alle Dateien in einem Verzeichnis abrufen:

https://documentation.arunox.dev/api.php?files=library/ARUNOX/Database/*

3. Dateien und Verzeichnisse kombinieren:

https://documentation.arunox.dev/api.php?files=library/ARUNOX/Database/*,library/ARUNOX/Config

Antwort

Die API gibt den kombinierten Inhalt der angegebenen Dateien als Klartext zurück (Content-Type: text/plain). Beispiel:


/** Datei: library/ARUNOX/Database.php **/
<?php
namespace ARUNOX\Database;

class Database {
// Inhalt der Datei
}
/** Datei: library/ARUNOX/Database/Filters.php **/
<?php
namespace ARUNOX\Database;

class Filters {
// Inhalt der Datei
}

Fehlerbehandlung

Wenn ein Fehler auftritt, gibt die API eine JSON-Antwort mit einer Fehlermeldung zurück:


{
"error": "File not allowed or not found: library/ARUNOX/InvalidFile"
}

Best Practices