27cfa9ac13
Collection Bruno (.bru text files, comme Postman mais file-based versionable) qui couvre l'API V1 actuelle. Open Collection → bruno/ → sélectionner l'environnement "local". Domaines couverts (22 requêtes) : - 00-Auth : Signup, Login, Logout - 01-Account : Get/Update profile - 02-Organizations : Get/Update my org - 03-Clients : List, List+stats, Search, Create, Create duplicate (409), Create without email (422), Get detail, Update - 04-Plans : List, Get by slug, Update (steps remplacés) - 05-Invoices : List, List+filters, Counts, Create, Get detail, Mark paid Environnement local (bruno/environments/local.bru) : - baseUrl, email/password/fullName en dur - token, userId, organizationId, clientId, invoiceId remplis automatiquement par les script:post-response Chaque requête a : - assertions Chai (statut, shape de la réponse) - bloc docs avec sémantique métier + erreurs typiques - inheritance auth Bearer via folder.bru pour ne pas répéter le header Mise à jour de docs/tech/dev-setup.md pour pointer vers la collection. Le parcours recommandé Signup → Update org → Create client → Create invoice → Mark paid couvre le happy path et permet de checker rubisCount qui s'incrémente.
59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
# Rubis API — Collection Bruno
|
|
|
|
Collection [Bruno](https://www.usebruno.com/) qui répertorie toutes les routes de l'API et permet de les tester en suivant un parcours réaliste (signup → onboarding → création client → facture → encaissement).
|
|
|
|
## Installation
|
|
|
|
1. Installe Bruno : https://www.usebruno.com/downloads
|
|
2. Dans Bruno, **Open Collection** → sélectionne le dossier `bruno/` à la racine du repo.
|
|
3. Sélectionne l'environnement **local** dans le sélecteur en haut à droite.
|
|
|
|
## Démarrer l'API
|
|
|
|
```bash
|
|
pnpm dev:up # Postgres, Redis, MinIO, Mailpit
|
|
pnpm dev:api # API sur http://localhost:3333
|
|
```
|
|
|
|
Si la DB est neuve : `pnpm -F api exec node ace migration:run`
|
|
|
|
## Variables d'environnement
|
|
|
|
Définies dans `environments/local.bru`. Les valeurs **vides** (token, userId, etc.) sont remplies automatiquement par les `script:post-response` :
|
|
|
|
| Variable | Source | Utilisée par |
|
|
|---|---|---|
|
|
| `baseUrl` | en dur (`http://localhost:3333`) | toutes |
|
|
| `email` / `password` / `fullName` | en dur (login fixture) | Signup, Login |
|
|
| `token` | rempli après Signup/Login | toutes les routes auth |
|
|
| `userId` | rempli après Signup/Login | (info) |
|
|
| `organizationId` | rempli après Signup/Login | (info, debug) |
|
|
| `clientId` | rempli après Create client | détail/update client, création facture |
|
|
| `planSlug` | en dur (`standard-30j`) | détail/update plan |
|
|
| `invoiceId` | rempli après Create invoice | détail/mark-paid |
|
|
|
|
## Parcours recommandé (premier run)
|
|
|
|
1. **Auth → 01 Signup** (récupère un token + crée l'org + provisionne les 4 plans)
|
|
2. **Account → 01 Get profile** (vérifie l'auth)
|
|
3. **Organizations → 02 Update my org** (onboarding step 2)
|
|
4. **Clients → 04 Create** (crée un client, capture `clientId`)
|
|
5. **Plans → 01 List** (vérifie les 4 plans pré-fournis)
|
|
6. **Invoices → 04 Create** (crée une facture liée au client)
|
|
7. **Invoices → 05 Get detail** (vérifie la timeline)
|
|
8. **Invoices → 06 Mark paid** (encaisse + bonus rubis)
|
|
9. **Organizations → 01 Get my org** (vérifie `rubisCount` incrémenté)
|
|
10. **Clients → 02 List with stats** (vérifie les compteurs)
|
|
|
|
## Reset entre runs
|
|
|
|
L'email `alice@bruno.test` est unique en DB → 2e signup retourne 422 `email_taken`.
|
|
Pour repartir propre :
|
|
|
|
```bash
|
|
docker exec rubis-postgres psql -U rubis -d rubis_dev -c "DROP SCHEMA public CASCADE; CREATE SCHEMA public;"
|
|
pnpm -F api exec node ace migration:run
|
|
```
|
|
|
|
Ou change `email` dans l'environnement local pour forcer un nouveau signup à chaque run.
|