Aller au contenu

Session 16 — Référence API complète (~70 endpoints) + Décomposition journal MkDocs

Durée : ~4 heures
Contexte : Session de documentation structurelle. Génération de la référence API exhaustive PerfShop et décomposition du journal de vibe coding monolithique en fichiers MkDocs par session.

🎯 Objectif de la session

Deux axes complémentaires :

  1. Référence API — documenter les ~70 endpoints REST de PerfShop avec méthode, chemin, paramètres, codes retour et exemples curl.
  2. Journal MkDocs — transformer le fichier BILAN_SESSION_VIBE_CODING.md monolithique en pages MkDocs individuelles (session-01.md → session-15.md) navigables via mkdocs.yml.

📦 Fichiers modifiés / créés

Fichier Nature
mkdocs/docs/api-reference.md Référence API complète (~70 endpoints)
mkdocs/docs/vibe-coding/session-01.md → session-15.md Décomposition par session
mkdocs/docs/vibe-coding/session-index.md Index des sessions avec tableau récapitulatif
mkdocs/mkdocs.yml Navigation vibe-coding/ ajoutée

🔧 Référence API — structure

Familles d'endpoints documentées

Famille Endpoints Exemples
Produits 8 GET /api/products, GET /api/products/{id}, pagination, recherche
Commandes 6 POST /api/orders, GET /api/orders/{id}, statuts
Authentification 4 POST /api/auth/login, POST /api/auth/logout, session
Admin 8 GET /api/admin/status, login admin, gestion anomalies
Chaos Backend 12 /api/chaos/cpu, /api/chaos/memory, sliders 0–100
Chaos Fonctionnel 6 /api/chaos/functional/level, statuts F1–F4
Chaos Métier 8 /api/chaos/business/anomaly, A1–A16
Chaos Scripting 6 /api/chaos/scripting/level, tokens niveau 0→4
Chaos Sécurité 8 /api/chaos/security/level, S1–S12
Portail Admin caché 4 /api/admin/portal/* (niveau 4 Master uniquement)
Monitoring public 4 /api/chaos/public/* (sans auth)
Métriques 4 /actuator/prometheus, /actuator/health

Conventions documentées

  • Auth session cookie (JSESSIONID) pour tous les endpoints protégés
  • X-Admin-Token HMAC-SHA256 pour les routes admin
  • Pagination standardisée : ?page=0&size=20&sort=name,asc
  • Codes retour cohérents : 200/201 succès, 400 validation, 401/403 auth, 404 introuvable, 409 conflit

🗂️ Décomposition journal MkDocs

Problème résolu

Le BILAN_SESSION_VIBE_CODING.md (~2000 lignes) était difficile à naviguer et à maintenir. Chaque session est désormais un fichier indépendant avec :

  • En-tête normalisé (date, durée, contexte)
  • Section objectifs
  • Tableau fichiers modifiés
  • Détails techniques
  • Bilan qualité / erreurs Claude
  • Valeur pédagogique

Structure MkDocs finale

mkdocs/docs/
├── index.md
├── api-reference.md          ← nouveau
├── vibe-coding/
│   ├── session-index.md      ← index avec tableau récapitulatif
│   ├── session-01.md → session-15.md
│   └── (session-16.md+)

🗂️ Bilan qualité

Erreurs Claude cette session : 0 régression fonctionnelle
Session purement documentaire — aucun code backend/frontend modifié.