maira-cli
MairaCLI ist ein Entwicklerwerkzeug, das automatisch Swagger-Dokumentation für Endpunkte generiert, indem es Anfragen und Antworten während des Testens der API-Endpunkte abfängt.
Aufgeführt in Kategorien:
EntwicklerwerkzeugeKategorienOpen Source
Beschreibung
MairaCLI ist ein Entwicklerwerkzeug, das entwickelt wurde, um automatisch Swagger-Dokumentation für API-Endpunkte zu generieren, indem es Anfragen und Antworten während des Testens abfängt.
Wie man benutzt maira-cli?
Um MairaCLI zu verwenden, installieren Sie es über npm, starten Sie den Proxy-Server innerhalb Ihres Backend-Projekts, konfigurieren Sie die erforderlichen Details in der config.json-Datei und senden Sie Anfragen an Ihr Backend über den Proxy-Server. Nach dem Senden von Anfragen generieren Sie die Dokumentation mit dem bereitgestellten Befehl.
Hauptmerkmale von maira-cli:
1️⃣
Generiert automatisch Swagger-Dokumentation für API-Endpunkte
2️⃣
Fängt Anfragen und Antworten für eine genaue Dokumentation ab
3️⃣
Erstellt Konfigurationsdateien für Projekt-Routen
4️⃣
Generiert Vorschau-Links für die Dokumentation
5️⃣
Unterstützt benutzerdefinierte Authentifizierungsheader
Warum könnte verwendet werden maira-cli?
| # | Anwendungsfall | Status | |
|---|---|---|---|
| # 1 | Generierung von API-Dokumentation für Backend-Projekte | ✅ | |
| # 2 | Testen von API-Endpunkten während der Dokumentation | ✅ | |
| # 3 | Erstellung von Swagger-Dokumentation für Microservices | ✅ | |
Wer hat entwickelt maira-cli?
MairaCLI wird von einer Gemeinschaft von Mitwirkenden auf GitHub entwickelt, die darauf abzielt, den Prozess der API-Dokumentation für Entwickler zu vereinfachen.