🚀 OneLineSwagger

La documentation API qui s'écrit pendant que vous codez.

**OneLineSwagger ** transforme votre flux de test en documentation officielle. En agissant comme un proxy intelligent, il capture vos requêtes et réponses réelles pour générer une interface Swagger (OpenAPI) complète, sans que vous n'ayez à écrire une seule ligne d'annotation dans votre code.

Pourquoi OneLineSwagger ?

L'approche traditionnelle de la documentation est souvent lourde et vite obsolète. OneLineSwagger change la donne :

• Traffic-First : Votre doc se construit au fur et à mesure que vous utilisez vos routes.
• Framework Agnostic : Fonctionne avec Laravel, Node, Python, Go, Ruby...
• Mise à jour en temps réel : Modifiez votre code, testez la route, et la doc est à jour.
• Support Auth : Détecte automatiquement vos tokens (Bearer/Sanctum) et active le bouton "Authorize".
• Descriptions IA : Utilise l'IA pour générer des descriptions humaines basées sur vos endpoints.

⚡️ Démarrage Rapide

1. Lancez OneLineSwagger

Ciblez le port de votre API locale (ex: Laravel sur le port 8000) et créez un proxy sur le port 8080 :

# Optionnel : Configurez votre clé IA pour des descriptions automatiques
export GROQ_API_KEY=gsk_your_key_here

# Lancez l'outil
npx one-line-swagger http://localhost:8000 -p 8080

2. Utilisez votre API

Faites vos tests (Postman, Navigateur) en utilisant le port du proxy (8080).

3. Visualisez la doc

Accédez à votre documentation interactive directement sur : 👉 http://localhost:8080/docs

Le Workflow Idéal (Développement Live)

Laissez l'outil tourner en arrière-plan pendant votre session de développement :

1. Codez votre route.
2. Testez-la via le port 8080.
3. Vérifiez : Elle est déjà documentée sur /docs.
4. Réinitialisez : Pour repartir de zéro, supprimez simplement le fichier .oneline-traffic.json.

⚙️ Options du CLI

| Option | Description | Par défaut | | :--- | :--- | :--- | | -p, --port | Port sur lequel le proxy va tourner | 8080 | | --path | URL personnalisée pour accéder à la doc | /docs |

🤝 Contribuer & Collaborer

Les contributions sont les bienvenues ! Je suis ouvert à toute collaboration pour faire évoluer cet outil (amélioration du proxy, nouveaux parsers, interface UI...).

1. Fork le projet.
2. Crée ta branche (git checkout -b feature/AmazingFeature).
3. Commit tes changements (git commit -m 'Add some AmazingFeature').
4. Push sur la branche (git push origin feature/AmazingFeature).
5. Ouvre une Pull Request.

📦 Passage en Production

Une fois votre API prête :

1. Appuyez sur CTRL+C dans votre terminal de dev.
2. Un fichier swagger-doc.html est généré automatiquement.
3. Déposez ce fichier dans le dossier public de votre serveur web.

Votre documentation est prête pour vos clients sur https://votre-api.com/swagger-doc.html !

📄 Licence

Distribué sous la licence ISC.

Développé pour les développeurs qui veulent coder, pas documenter.