maira-cli
MairaCLI es una herramienta para desarrolladores diseñada para generar automáticamente documentación Swagger para los puntos finales interceptando solicitudes y respuestas mientras se prueban los puntos finales de la API.
Listado en categorías:
Herramientas de desarrolloCategoríasCódigo abierto
Descripción
MairaCLI es una herramienta para desarrolladores diseñada para generar automáticamente documentación Swagger para los endpoints de API al interceptar solicitudes y respuestas durante las pruebas.
Cómo usar maira-cli?
Para usar MairaCLI, instálalo a través de npm, inicia el servidor proxy dentro de tu proyecto de backend, configura los detalles necesarios en el archivo config.json y realiza solicitudes a tu backend a través del servidor proxy. Después de realizar las solicitudes, genera la documentación utilizando el comando proporcionado.
Características principales de maira-cli:
1️⃣
Genera automáticamente documentación Swagger para endpoints de API
2️⃣
Intercepta solicitudes y respuestas para una documentación precisa
3️⃣
Crea archivos de configuración para las rutas del proyecto
4️⃣
Genera enlaces de vista previa de la documentación
5️⃣
Soporta encabezados de autenticación personalizados
Por qué podría ser usado maira-cli?
| # | Caso de Uso | Estado | |
|---|---|---|---|
| # 1 | Generar documentación de API para proyectos de backend | ✅ | |
| # 2 | Probar endpoints de API mientras se documentan | ✅ | |
| # 3 | Crear documentación Swagger para microservicios | ✅ | |
Desarrollado por maira-cli?
MairaCLI es desarrollado por una comunidad de colaboradores en GitHub, con el objetivo de simplificar el proceso de documentación de API para los desarrolladores.