feat(docs): update and reorganize API reference structure
- Refactored API endpoint documentation using individual accordions for better clarity. - Added detailed descriptions for `/contents`, `/categories`, `/favorites`, `/reports`, `/api-keys`, `/tags`, `/media`, and `/admin` endpoints. - Improved consistency in query parameters and usage examples.
This commit is contained in:
Mathis HERRIOT
@@ -119,28 +119,38 @@ Cette page documente tous les points de terminaison disponibles sur l'API Memego
|
||||
</Callout>
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Gestion 2FA">
|
||||
- `POST /users/me/2fa/setup` : Génère un secret et QR Code.
|
||||
- `POST /users/me/2fa/enable` : Active après vérification du jeton.
|
||||
- `POST /users/me/2fa/disable` : Désactive avec jeton.
|
||||
<Accordion title="POST /users/me/2fa/setup">
|
||||
Génère un secret et un QR Code pour la configuration de la 2FA.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Administration (Admin uniquement)">
|
||||
- `GET /users/admin` : Liste tous les utilisateurs (avec pagination `limit`, `offset`).
|
||||
- `DELETE /users/:uuid` : Supprime définitivement un utilisateur par son UUID.
|
||||
<Accordion title="POST /users/me/2fa/enable">
|
||||
Active la 2FA après vérification du jeton TOTP.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="POST /users/me/2fa/disable">
|
||||
Désactive la 2FA en utilisant un jeton TOTP valide.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="GET /users/admin">
|
||||
Liste tous les utilisateurs (réservé aux administrateurs).
|
||||
**Query Params :** `limit`, `offset`.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="DELETE /users/:uuid">
|
||||
Supprime définitivement un utilisateur par son UUID (réservé aux administrateurs).
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### 🖼️ Contenus (`/contents`)
|
||||
|
||||
<Accordions>
|
||||
<Accordion title="GET /contents/explore | /trends | /recent">
|
||||
Recherche et filtre les contenus. Ces endpoints sont mis en cache (Redis + Navigateur).
|
||||
<Accordion title="GET /contents/explore">
|
||||
Recherche et filtre les contenus. Cet endpoint est mis en cache.
|
||||
|
||||
**Query Params :**
|
||||
- `limit` (number) : Défaut 10.
|
||||
- `offset` (number) : Défaut 0.
|
||||
- `sort` : `trend` | `recent` (uniquement sur `/explore`)
|
||||
- `sort` : `trend` | `recent`
|
||||
- `tag` (string) : Filtrer par tag.
|
||||
- `category` (slug ou id) : Filtrer par catégorie.
|
||||
- `author` (username) : Filtrer par auteur.
|
||||
@@ -149,6 +159,14 @@ Cette page documente tous les points de terminaison disponibles sur l'API Memego
|
||||
- `userId` (uuid) : Filtrer les contenus d'un utilisateur spécifique.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="GET /contents/trends">
|
||||
Récupère les contenus les plus populaires du moment.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="GET /contents/recent">
|
||||
Récupère les contenus les plus récents.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="GET /contents/:idOrSlug">
|
||||
Récupère un contenu par son ID ou son Slug.
|
||||
|
||||
@@ -178,8 +196,12 @@ Cette page documente tous les points de terminaison disponibles sur l'API Memego
|
||||
**Query Param :** `fileName` (string).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="POST /contents/:id/view | /use">
|
||||
Incrémente les statistiques de vue ou d'utilisation.
|
||||
<Accordion title="POST /contents/:id/view">
|
||||
Incrémente le compteur de vues d'un contenu.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="POST /contents/:id/use">
|
||||
Incrémente le compteur d'utilisation d'un contenu.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="DELETE /contents/:id">
|
||||
@@ -191,58 +213,111 @@ Cette page documente tous les points de terminaison disponibles sur l'API Memego
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### 📂 Catégories, ⭐ Favoris, 🚩 Signalements
|
||||
### 📂 Catégories (`/categories`)
|
||||
|
||||
<Accordions>
|
||||
<Accordion title="Catégories (/categories)">
|
||||
- `GET /categories` : Liste toutes les catégories.
|
||||
- `GET /categories/:id` : Détails d'une catégorie.
|
||||
- `POST /categories` : Création (Admin uniquement).
|
||||
- `PATCH /categories/:id` : Mise à jour (Admin uniquement).
|
||||
- `DELETE /categories/:id` : Suppression (Admin uniquement).
|
||||
<Accordion title="GET /categories">
|
||||
Liste toutes les catégories de mèmes disponibles.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Favoris (/favorites)">
|
||||
Requiert l'authentification.
|
||||
- `GET /favorites` : Liste les favoris de l'utilisateur (avec pagination `limit`, `offset`).
|
||||
- `POST /favorites/:contentId` : Ajoute un favori.
|
||||
- `DELETE /favorites/:contentId` : Retire un favori.
|
||||
<Accordion title="GET /categories/:id">
|
||||
Récupère les détails d'une catégorie spécifique.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Signalements (/reports)">
|
||||
- `POST /reports` : Signale un contenu ou un tag.
|
||||
- `GET /reports` : Liste des signalements (Pagination `limit`, `offset`). **Admin/Modérateurs**.
|
||||
- `PATCH /reports/:id/status` : Change le statut (`pending`, `resolved`, `dismissed`). **Admin/Modérateurs**.
|
||||
<Accordion title="POST /categories">
|
||||
Crée une nouvelle catégorie (**Admin uniquement**).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="PATCH /categories/:id">
|
||||
Met à jour une catégorie existante (**Admin uniquement**).
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="DELETE /categories/:id">
|
||||
Supprime une catégorie (**Admin uniquement**).
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### 🔑 Clés API & 🏷️ Tags
|
||||
### ⭐ Favoris (`/favorites`)
|
||||
|
||||
<Accordions>
|
||||
<Accordion title="Clés API (/api-keys)">
|
||||
- `POST /api-keys` : Génère une clé `{ name, expiresAt? }`.
|
||||
- `GET /api-keys` : Liste les clés actives.
|
||||
- `DELETE /api-keys/:id` : Révoque une clé.
|
||||
<Accordion title="GET /favorites">
|
||||
Liste les favoris de l'utilisateur connecté.
|
||||
**Query Params :** `limit`, `offset`.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Tags (/tags)">
|
||||
- `GET /tags` : Recherche de tags.
|
||||
- **Params :** `query` (recherche), `sort` (`popular` | `recent`), `limit`, `offset`.
|
||||
<Accordion title="POST /favorites/:contentId">
|
||||
Ajoute un contenu aux favoris de l'utilisateur.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="DELETE /favorites/:contentId">
|
||||
Retire un contenu des favoris de l'utilisateur.
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### 🛠️ Système & Médias
|
||||
### 🚩 Signalements (`/reports`)
|
||||
|
||||
<Accordions>
|
||||
<Accordion title="Santé (/health)">
|
||||
- `GET /health` : Vérifie l'état de l'API et de la connexion à la base de données.
|
||||
<Accordion title="POST /reports">
|
||||
Signale un contenu ou un tag inapproprié.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Médias (/media)">
|
||||
- `GET /media?path=key` : Accès direct aux fichiers stockés sur S3 via le paramètre `path`. Supporte la mise en cache agressive.
|
||||
<Accordion title="GET /reports">
|
||||
Liste tous les signalements (**Admin/Modérateurs uniquement**).
|
||||
**Query Params :** `limit`, `offset`.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Administration (/admin)">
|
||||
- `GET /admin/stats` : Récupère les statistiques globales de la plateforme. **Admin uniquement**.
|
||||
<Accordion title="PATCH /reports/:id/status">
|
||||
Change le statut d'un signalement (`pending`, `resolved`, `dismissed`) (**Admin/Modérateurs uniquement**).
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### 🔑 Clés API (`/api-keys`)
|
||||
|
||||
<Accordions>
|
||||
<Accordion title="POST /api-keys">
|
||||
Génère une nouvelle clé API pour l'utilisateur.
|
||||
**Corps :** `{ name, expiresAt? }`.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="GET /api-keys">
|
||||
Liste toutes les clés API actives de l'utilisateur.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="DELETE /api-keys/:id">
|
||||
Révoque une clé API spécifique.
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### 🏷️ Tags (`/tags`)
|
||||
|
||||
<Accordions>
|
||||
<Accordion title="GET /tags">
|
||||
Recherche et liste les tags populaires ou récents.
|
||||
**Query Params :** `query`, `sort` (`popular` | `recent`), `limit`, `offset`.
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### 🛠️ Système (`/health`)
|
||||
|
||||
<Accordions>
|
||||
<Accordion title="GET /health">
|
||||
Vérifie l'état de santé de l'API et de ses dépendances (Base de données, Redis, etc.).
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### 📁 Médias (`/media`)
|
||||
|
||||
<Accordions>
|
||||
<Accordion title="GET /media">
|
||||
Accès direct aux fichiers multimédias.
|
||||
**Query Param :** `path` (clé du fichier sur S3).
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
### 📊 Administration (`/admin`)
|
||||
|
||||
<Accordions>
|
||||
<Accordion title="GET /admin/stats">
|
||||
Récupère les statistiques globales d'utilisation de la plateforme (**Admin uniquement**).
|
||||
</Accordion>
|
||||
</Accordions>
|
||||
|
||||
Reference in New Issue
Block a user