API Backend¶

Documentation du backend NestJS de Bricks.

Le code source vit dans projects/api/src/ et est organisé selon une architecture modulaire dans projects/api/src/__new/modules/. La documentation est co-localisée : chaque module ou contrôleur peut maintenir son propre dossier docs/ à côté du code, et tout est agrégé automatiquement par awesome-pages.

Sections¶

Modules — flux métier documentés par module (Primary Purchase, Investor Withdraw Request, Espace-Fi…)
Endpoints — référence des contrôleurs : un fichier par contrôleur regroupant ses routes (méthode, path, payload, response, lien vers le module qui implémente le flux)
Tests d'intégration — lancer et écrire les tests d'intégration (Vitest + Postgres/Redis réelles), + conventions

Pour ajouter de la doc¶

Doc de module : crée un dossier docs/ dans src/__new/modules/<module>/, ajoute des .md dedans. Visible automatiquement dans Modules.
Doc de contrôleur : crée un dossier docs/ dans src/<controller-folder>/, ajoute un <name>.md. Visible automatiquement dans Endpoints.

Pour customiser titres et ordre dans la nav, ajoute un fichier .pages (YAML) dans le dossier concerné.