Auf die API kann via api.xefili.dev zugegriffen werden. Alle Routen starten mit einem / und destruktive Routen sind password-geschützt.
/articles
Dieser Endpunkt liefert jegliche Artikel als JSON Array. Mit der Methode POST können Administratoren Artikels hinzufügen. Wenn die Methode POST genutzt wird muss der X-API-KEY header gesetzt sein. Anderfalls wird der HTTP 401 Status Code geantwortet.
Eine mögliche Antwort der API sieht etwa so aus:
/articles/:id
Dieser Endpunkt zeigt den Artikel mit der angegebenen ID als JSON-Array-Element an. Artikel können auch mit Vorsicht aktualisiert werden, da die Struktur nicht validiert wird und der Anforderungstext auf die ID des Artikels gesetzt wird. Daher muss die Anfrage strukturell korrekt sein und mit dem richtigen Header autorisiert werden. Administratoren können Artikel mit der DELETE-Methode löschen, hierfür muss der X-API-Key-Header gesetzt sein. Wenn es nicht gesetzt ist oder falsche Werte hat, gibt die API den Status 401 zurück.
/config
Dieser Endpunkt zeigt aktuelle Informationen zur API und Konfiguration oder Feature-Flags für die Websites an.
/search?query="query"
Dieser Endpunkt verwendet die integrierte Suchfunktion, um Ergebnisse aus dem Abfrageparameter zu suchen. Die Suche indiziert die Titel der Artikel. Es kann auch ein optionaler Grenzwertparameter übergeben werden; /search?query="query"&limit=INT. Der Grenzwertparameter akzeptiert jede positive Ganzzahl. Andere Werte führen zu einem HTTP 500, da ich keine vermeidbaren Fehler behandle.