maira-cli
MairaCLI è uno strumento per sviluppatori progettato per generare automaticamente documentazione Swagger per gli endpoint intercettando richieste e risposte durante il test degli endpoint API.
Elencato nelle categorie:
Strumenti per sviluppatoriCategorieOpen Source
Descrizione
MairaCLI è uno strumento per sviluppatori progettato per generare automaticamente la documentazione Swagger per gli endpoint API intercettando le richieste e le risposte durante i test.
Come usare maira-cli?
Per utilizzare MairaCLI, installalo tramite npm, avvia il server proxy all'interno del tuo progetto backend, configura i dettagli necessari nel file config.json e fai richieste al tuo backend tramite il server proxy. Dopo aver effettuato le richieste, genera la documentazione utilizzando il comando fornito.
Funzionalità principali di maira-cli:
1️⃣
Genera automaticamente la documentazione Swagger per gli endpoint API
2️⃣
Intercetta le richieste e le risposte per una documentazione accurata
3️⃣
Crea file di configurazione per le rotte del progetto
4️⃣
Genera link di anteprima della documentazione
5️⃣
Supporta intestazioni di autenticazione personalizzate
Perché potrebbe essere usato maira-cli?
| # | Caso d'uso | Stato | |
|---|---|---|---|
| # 1 | Generazione di documentazione API per progetti backend | ✅ | |
| # 2 | Test degli endpoint API mentre li si documenta | ✅ | |
| # 3 | Creazione di documentazione Swagger per microservizi | ✅ | |
Sviluppato da maira-cli?
MairaCLI è sviluppato da una comunità di collaboratori su GitHub, con l'obiettivo di semplificare il processo di documentazione API per gli sviluppatori.