L'API est accessible via api.xefili.dev. Toutes les routes commencent par un / et les routes destructrices sont protégées par mot de passe.
/articles
Ce point de terminaison renvoie tous les articles sous forme de tableau JSON. La méthode POST permet aux administrateurs d'ajouter des articles. Si la méthode POST est utilisée, l'en-tête X-API-KEY doit être défini. Sinon, le code d'état HTTP 401 sera répondu.
Une réponse possible de l'API ressemble à ceci :
/articles/:id
Ce point de terminaison affiche l'article avec l'ID spécifié en tant qu'élément de tableau JSON. Les articles peuvent également être mis à jour avec prudence car la structure n'est pas validée et le corps de la requête est défini sur l'ID de l'article. Par conséquent, la demande doit être structurellement correcte et autorisée avec le bon en-tête. Les administrateurs peuvent supprimer des éléments à l'aide de la méthode DELETE ; cela nécessite la définition de l'en-tête X-API-Key. Si elle n'est pas définie ou a des valeurs incorrectes, l'API renvoie le statut 401.
/config
Ce point de terminaison affiche les informations actuelles sur l'API et la configuration ou les indicateurs de fonctionnalités pour les sites Web.
/search?query="query"
Ce point de terminaison utilise la fonctionnalité de recherche intégrée pour rechercher les résultats du paramètre de requête. La recherche indexe les titres des articles. Un paramètre de limite facultatif peut également être transmis ; /search?query="query"&limit=INT. Le paramètre limit accepte tout entier positif. D'autres valeurs donnent un HTTP 500 car je ne gère pas les erreurs évitables.