@api-doc-generatorDoc API auto depuis ton code, pas d'invention

Le problème qu'il résout

Tu as une API Express avec 25 endpoints. Aucune doc. Ton frontend dev passe son temps à te demander "c'est quoi le format de POST /users ?". Tu veux générer une doc fidèle au code — pas une fiction qui ment.

@api-doc-generator lit ton code, pas son imagination.

Comment il bosse

1. Détecte la cible : lib publique, REST API, GraphQL, package interne.
2. Détecte le doc tool : TypeDoc, Sphinx, phpDocumentor, godoc, Javadoc, ou markdown générique.
3. Échantillonne les docs existants pour matcher tes conventions (frontmatter, directives, layout).
4. Pour chaque symbole public, extrait signature + docblock + types.
5. Si docblock et signature divergent, render la signature truthfully et flag la mismatch.
6. Cross-link les symboles entre eux. Index page avec groupement.

Exemple concret

Tu tapes

›@api-doc-generator génère la doc markdown pour tous les endpoints
dans src/routes/. Inclus : path, méthode, body, response, auth, codes erreur.

Tu obtiens (extrait)

### `POST /v1/users`

Create a new user account.

**Auth**: Bearer admin token required.

**Body**
- `email` (string, required) — user email (RFC valid)
- `name` (string, required) — display name, 1-100 chars
- `role` ('admin' | 'user', optional, default: 'user')

**Returns**
- 201 — { id, email, name, role, created_at }
- 400 — validation_failed (per-field errors)
- 401 — unauthorized
- 409 — duplicate email

**Example**
\`\`\`bash
curl -X POST https://api.example.com/v1/users \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"email":"alice@example.com","name":"Alice"}'
\`\`\`

Pourquoi tu vas l'aimer

Quand l'utiliser

Combine avec ces agents

Questions fréquentes