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.
31 lines
1.1 KiB
Plaintext
31 lines
1.1 KiB
Plaintext
docs {
|
|
# Rubis API
|
|
|
|
Collection Bruno qui couvre l'API REST de Rubis (`/api/v1/*`).
|
|
|
|
## Domaines
|
|
|
|
- **Auth** — signup / login / logout
|
|
- **Account** — profil utilisateur courant
|
|
- **Organizations** — organisation rattachée (V1 mono-tenant)
|
|
- **Clients** — fiches clients (CRUD + stats)
|
|
- **Plans** — plans de relance (4 pré-fournis + édition)
|
|
- **Invoices** — factures + counts + détail enrichi + mark-paid
|
|
|
|
## Conventions transverses
|
|
|
|
- **Auth** : Bearer token dans `Authorization`. Le token est capturé
|
|
automatiquement après Signup ou Login (`bru.setEnvVar('token', ...)`).
|
|
- **Wrapper** : toutes les réponses sont `{ data: ... }` (pour les
|
|
listes : `{ data, meta: { total, page } }`).
|
|
- **Erreurs** : `{ errors: [{ code, message, field? }] }` avec codes
|
|
stables (`validation_failed`, `duplicate_client`, `client_email_required`,
|
|
`not_found`, `unauthenticated`…).
|
|
- **IDs** : UUID v4 partout, jamais d'increments.
|
|
- **Montants** : centimes (int), jamais de float.
|
|
|
|
## Lancer l'API
|
|
|
|
Voir `bruno/README.md` à la racine du dossier.
|
|
}
|