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
2026-01-21 10:08:09 +01:00
parent d613a89e63
commit 57bc51290b

View File

@@ -119,28 +119,38 @@ Cette page documente tous les points de terminaison disponibles sur l'API Memego
</Callout> </Callout>
</Accordion> </Accordion>
<Accordion title="Gestion 2FA"> <Accordion title="POST /users/me/2fa/setup">
- `POST /users/me/2fa/setup` : Génère un secret et QR Code. Génère un secret et un QR Code pour la configuration de la 2FA.
- `POST /users/me/2fa/enable` : Active après vérification du jeton.
- `POST /users/me/2fa/disable` : Désactive avec jeton.
</Accordion> </Accordion>
<Accordion title="Administration (Admin uniquement)"> <Accordion title="POST /users/me/2fa/enable">
- `GET /users/admin` : Liste tous les utilisateurs (avec pagination `limit`, `offset`). Active la 2FA après vérification du jeton TOTP.
- `DELETE /users/:uuid` : Supprime définitivement un utilisateur par son UUID. </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> </Accordion>
</Accordions> </Accordions>
### 🖼️ Contenus (`/contents`) ### 🖼️ Contenus (`/contents`)
<Accordions> <Accordions>
<Accordion title="GET /contents/explore | /trends | /recent"> <Accordion title="GET /contents/explore">
Recherche et filtre les contenus. Ces endpoints sont mis en cache (Redis + Navigateur). Recherche et filtre les contenus. Cet endpoint est mis en cache.
**Query Params :** **Query Params :**
- `limit` (number) : Défaut 10. - `limit` (number) : Défaut 10.
- `offset` (number) : Défaut 0. - `offset` (number) : Défaut 0.
- `sort` : `trend` | `recent` (uniquement sur `/explore`) - `sort` : `trend` | `recent`
- `tag` (string) : Filtrer par tag. - `tag` (string) : Filtrer par tag.
- `category` (slug ou id) : Filtrer par catégorie. - `category` (slug ou id) : Filtrer par catégorie.
- `author` (username) : Filtrer par auteur. - `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. - `userId` (uuid) : Filtrer les contenus d'un utilisateur spécifique.
</Accordion> </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"> <Accordion title="GET /contents/:idOrSlug">
Récupère un contenu par son ID ou son Slug. 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). **Query Param :** `fileName` (string).
</Accordion> </Accordion>
<Accordion title="POST /contents/:id/view | /use"> <Accordion title="POST /contents/:id/view">
Incrémente les statistiques de vue ou d'utilisation. 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>
<Accordion title="DELETE /contents/:id"> <Accordion title="DELETE /contents/:id">
@@ -191,58 +213,111 @@ Cette page documente tous les points de terminaison disponibles sur l'API Memego
</Accordion> </Accordion>
</Accordions> </Accordions>
### 📂 Catégories, ⭐ Favoris, 🚩 Signalements ### 📂 Catégories (`/categories`)
<Accordions> <Accordions>
<Accordion title="Catégories (/categories)"> <Accordion title="GET /categories">
- `GET /categories` : Liste toutes les catégories. Liste toutes les catégories de mèmes disponibles.
- `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> </Accordion>
<Accordion title="Favoris (/favorites)"> <Accordion title="GET /categories/:id">
Requiert l'authentification. Récupère les détails d'une catégorie spécifique.
- `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> </Accordion>
<Accordion title="Signalements (/reports)"> <Accordion title="POST /categories">
- `POST /reports` : Signale un contenu ou un tag. Crée une nouvelle catégorie (**Admin uniquement**).
- `GET /reports` : Liste des signalements (Pagination `limit`, `offset`). **Admin/Modérateurs**. </Accordion>
- `PATCH /reports/:id/status` : Change le statut (`pending`, `resolved`, `dismissed`). **Admin/Modérateurs**.
<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> </Accordion>
</Accordions> </Accordions>
### 🔑 Clés API & 🏷️ Tags ### ⭐ Favoris (`/favorites`)
<Accordions> <Accordions>
<Accordion title="Clés API (/api-keys)"> <Accordion title="GET /favorites">
- `POST /api-keys` : Génère une clé `{ name, expiresAt? }`. Liste les favoris de l'utilisateur connecté.
- `GET /api-keys` : Liste les clés actives. **Query Params :** `limit`, `offset`.
- `DELETE /api-keys/:id` : Révoque une clé.
</Accordion> </Accordion>
<Accordion title="Tags (/tags)"> <Accordion title="POST /favorites/:contentId">
- `GET /tags` : Recherche de tags. Ajoute un contenu aux favoris de l'utilisateur.
- **Params :** `query` (recherche), `sort` (`popular` | `recent`), `limit`, `offset`. </Accordion>
<Accordion title="DELETE /favorites/:contentId">
Retire un contenu des favoris de l'utilisateur.
</Accordion> </Accordion>
</Accordions> </Accordions>
### 🛠️ Système & Médias ### 🚩 Signalements (`/reports`)
<Accordions> <Accordions>
<Accordion title="Santé (/health)"> <Accordion title="POST /reports">
- `GET /health` : Vérifie l'état de l'API et de la connexion à la base de données. Signale un contenu ou un tag inapproprié.
</Accordion> </Accordion>
<Accordion title="Médias (/media)"> <Accordion title="GET /reports">
- `GET /media?path=key` : Accès direct aux fichiers stockés sur S3 via le paramètre `path`. Supporte la mise en cache agressive. Liste tous les signalements (**Admin/Modérateurs uniquement**).
**Query Params :** `limit`, `offset`.
</Accordion> </Accordion>
<Accordion title="Administration (/admin)"> <Accordion title="PATCH /reports/:id/status">
- `GET /admin/stats` : Récupère les statistiques globales de la plateforme. **Admin uniquement**. 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> </Accordion>
</Accordions> </Accordions>