maira-cli
MairaCLI est un outil pour développeurs conçu pour générer automatiquement la documentation Swagger pour les points de terminaison en interceptant les requêtes et les réponses lors des tests des points de terminaison de l'API.
Listé dans les catégories:
Outils de développementCatégoriesOpen Source
Description
MairaCLI est un outil pour développeurs conçu pour générer automatiquement la documentation Swagger pour les points de terminaison API en interceptant les requêtes et les réponses pendant les tests.
Comment utiliser maira-cli?
Pour utiliser MairaCLI, installez-le via npm, démarrez le serveur proxy dans votre projet backend, configurez les détails nécessaires dans le fichier config.json, et effectuez des requêtes à votre backend via le serveur proxy. Après avoir effectué des requêtes, générez la documentation en utilisant la commande fournie.
Fonctionnalités principales de maira-cli:
1️⃣
Génère automatiquement la documentation Swagger pour les points de terminaison API
2️⃣
Intercepte les requêtes et les réponses pour une documentation précise
3️⃣
Crée des fichiers de configuration pour les routes du projet
4️⃣
Génère des liens d'aperçu de la documentation
5️⃣
Prend en charge les en-têtes d'authentification personnalisés
Pourquoi pourrait-il être utilisé maira-cli?
| # | Cas d'utilisation | Statut | |
|---|---|---|---|
| # 1 | Génération de documentation API pour des projets backend | ✅ | |
| # 2 | Test des points de terminaison API tout en les documentant | ✅ | |
| # 3 | Création de documentation Swagger pour des microservices | ✅ | |
Développé par maira-cli?
MairaCLI est développé par une communauté de contributeurs sur GitHub, visant à simplifier le processus de documentation API pour les développeurs.