Sharkio
? Was ist Sharkio
Sharkio ist ein Entwicklungsinstrument für API -Entwickler. Es ist ein Proxy, der alle Anfragen aufzeichnet, die an Ihre Server gesendet werden. Und bietet Ihnen ein Dashboard, um den gesamten Verkehr zu analysieren. Sharkio bietet auch die Möglichkeit, Anfragen zu wiederholen. Generieren Sie Typen für Ihre Lieblingssprache, die auf echten Daten basieren.
Hilf uns, dir zu helfen!
Roadmap
Im Roadmap wird Sharkio Teamfunktionen unterstützen. Außerdem wird Sharkio in ChatGPT integriert, um eine einfache Verwendung von API zu ermöglichen. Automatisierung anfordern. API -Inkonsistenz Alarmierung. Integration in Postbote. Automatische CLI -Generation für Ihre API mit echten Daten. Anfrage verspotten.
? Merkmale
| Feature -Name | Verfügbar |
|---|
| Verkehr inspizieren | ✅ |
| Suchen | ✅ |
| Filter | ✅ |
| Wiederholungsanforderung | ✅ |
| TypeScript -Generator | ✅ |
| JSON -Schema -Generator | ✅ |
| Microservice -Unterstützung | ✅ |
| Messeln fordern | ✅ |
| Öffnen Sie den API -Generator | ✅ |
| Anfragen speichern | ✅ |
| Sammlungen | ✅ |
| CHATGPT -Integration | |
| Anfragen teilen | |
? Tech Stack
Wie man benutzt
- Melden Sie sich bei https://sharkio.dev an
- Richten Sie Ihren Proxy ein (lokaler Server mit Ngrok oder Alternative)
- Ändern Sie die Konfiguration des Projekts, um https: // <generated_subdomain> .sniffer.sharkio.dev zu verwenden
- Sharkio verwenden?
Erste Schritte
In der Entwicklung laufen
- NPM I -g gleichzeitig TS -Node
Für das Backend
CD in Server.
NPM Installation
NPM Run Dev
Für das Frontend
CD in den Kunden.
NPM Installation
NPM Run Dev
Für beide:
NPM Run Dev (im Root -Verzeichnis)
Notiz:
- Wenn Sie möchten, dass ein Dummy -Server das Sniffing wie in visueller Demonstration der Verwendung gezeigt testet, und dann den Befehl follwoing ausführen:
-
npm run demo (im Root -Verzeichnis)
Laufen in Produktion - mit Docker
Ganzes Projekt ausführen:
- Verwenden Sie in der Root of Project:
-
docker-compose up - HINWEIS: Verwenden Sie die Ports 5550-5560 als Proxies. Stellen Sie sicher, dass sie verfügbar sind.
Nur Backend/Frontend rennen:
-
cd zu Relevent Ordner - Erstellen Sie das Docker -Bild:
npm run docker:build - Führen Sie die App aus:
npm run docker:run
❓ FAQs einrichten:
[1] Der Vor-Commit-Haken wird während der normalen Installation nicht installiert. Was soll ich tun?
Um Husky [Pre-Commit Hook] manuell durch Ausführen dieses Befehls einzurichten: `NPM Run Prepect` [2] Was enthält das Verzeichnis "Traffic-Dasboard" und "Traffic-Snifer"?
`Traffic-Dasboard" ist der Frontend-Code || "Verkehrs-Snifer" ist der Backend-Code ⚡ Soziale Links
- PRODUCTTHUNT -Seite: https://www.producthunt.com/posts/sharkio Start findet in Kürze statt!
- Discord Server: https://discord.gg/fxumxd23
Willst du einen Beitrag leisten?
- Geben Sie das Repo auf, klonen Sie es in Ihre lokale Umgebung und erkunden Sie den Code.
- Suchen Sie nach einem Problem, vorzugsweise aus der nächsten Meilensteinliste.
- Bitten Sie, dem Problem zugewiesen zu werden.
- Stecken geblieben? Benötigen Sie einen Rat? Finden Sie uns auf dem Discord -Server.
- Einen Fehler gefunden? ? Bitte öffnen Sie ein Problem.
? Anerkennung
- Das wurde damit gemacht? Readme Generator - Readme.so
? Mitwirkende
All unsere Mitwirkenden schätzen:
