Allgemeine Einführung
api-check ist ein reines Front-End-API-Testing-Tool, das vom Entwickler october-coder auf GitHub zur Verfügung gestellt wird. Es wird hauptsächlich verwendet, um die Benutzerfreundlichkeit von API-Schnittstellen zu testen, vor allem für OpenAI-Proxy-APIs wie oneapi und newapi. Es wird hauptsächlich verwendet, um die Benutzerfreundlichkeit von API-Schnittstellen zu testen, vor allem Unterstützung für OpenAI Proxy-APIs, wie oneapi und newapi. alle Operationen werden im Browser abgeschlossen, nicht auf die Back-End-Servern verlassen, um die Datensicherheit zu gewährleisten, während die Vermeidung von Netzwerk-Timeout-Probleme. Das Tool liefert detaillierte Daten wie Antwortzeit und Modellkonsistenz und unterstützt auch Testkonfigurationen mit Cloud- und lokalem Speicher. api-check ist einfach zu bedienen, unterstützt chinesische und englische Schnittstellen sowie dunkle und helle Farbmodi und eignet sich für Entwickler zur schnellen Überprüfung der API-Leistung. Für eine hohe Flexibilität kann es über Vercel, Docker oder Cloudflare bereitgestellt werden.
Funktionsliste
- Testen Sie die Verfügbarkeit von OpenAI-Agent-APIs wie oneapi und newapi.
- Zeigt API-Antwortzeiten, Modellkonsistenz und System-Fingerabdrücke mit deutlich sichtbaren Ergebnissen an.
- Unterstützt Cloud-Speicher, um Testkonfigurationen auf dem Server zu speichern und mit mehreren Geräten zu synchronisieren.
- Unterstützt lokale Speicherung, Zwischenspeicherung von Konfigurationen im Browser für schnelles Laden.
- Ermöglicht das Umschalten zwischen dunklem und hellem Farbmodus und passt sich so an unterschiedliche Nutzungsumgebungen an.
- Unterstützt chinesische und englische Benutzeroberflächen, um unterschiedlichen Benutzeranforderungen gerecht zu werden.
- Integrieren Sie schnelle Chat-Tests, um die Reaktionsfähigkeit des Modells zu überprüfen.
- Unterstützt Batch-Tests von GPT, Claude und Zwillinge des Schlüssels.
- Bietet eine Ein-Klick-Kopierfunktion zur einfachen Weitergabe von Testergebnissen.
- Unterstützt die Bereitstellungsmethoden Vercel, Docker und Cloudflare.
Hilfe verwenden
Installation und Einsatz
api-check ist ein reines Front-End-Tool. Sie können die Online-Version direkt verwenden oder sie selbst einsetzen. Nachfolgend finden Sie die detaillierten Schritte für die drei Bereitstellungsmethoden:
Einsatz in Vercel
- Zugriff auf GitHub-Repositories
zeigen (eine Eintrittskarte)https://github.com/october-coder/api-check
gehen Sie auf die Projektseite. - Ein-Klick-Bereitstellung
Klicken Sie auf die Schaltfläche "Deploy with Vercel" auf der Seite, oder gehen Sie direkt zurhttps://vercel.com/new/clone?repository-url=https://github.com/october-coder/api-check
. - Einloggen und konfigurieren
Melden Sie sich mit Ihrem GitHub-Konto bei Vercel an und fügen Sie das Backend-Passwort auf der Seite mit den Umgebungsvariablen hinzu, zum Beispiel:- Schlüssel:
PASSWORD
Wert:your_password
.
- Schlüssel:
- Einsatz abgeschlossen
Klicken Sie auf "Deploy" und nach ein paar Minuten wird eine Adresse generiert, zum Beispielhttps://api-check-yourname.vercel.app
. - Optionale Operationen
Wenn Sie einen benutzerdefinierten Domänennamen binden müssen, finden Sie unterhttps://vercel.com/docs/concepts/projects/domains/add-a-domain
um zu vermeiden, dass der Standarddomänenname in bestimmten Regionen eingeschränkt wird.
Docker-Bereitstellung
- Befehl ausführen
Geben Sie den folgenden Befehl in das Terminal ein, um die Bereitstellung mit einem Mausklick zu ermöglichen:
docker run -d -p 13000:13000 -e PASSWORD=your_password -v your_path:/app/data --name api-check ghcr.io/rickcert/api-check:latest
- Beschreibung der Parameter
-p 13000:13000
Mapping port to local 13000.-e PASSWORD
: Legen Sie das Zugangspasswort fest.-v your_path:/app/data
: Gibt den lokalen Speicherpfad an.
- Zugriffswerkzeug
Sobald die Bereitstellung abgeschlossen ist, öffnen Sie Ihren Browser und geben Siehttp://localhost:13000
.
Cloudflare-Bereitstellung
- Referenz-Tutorial
Interviewshttps://github.com/october-coder/api-check/blob/main/docs/cloudflare.md
folgen Sie den Schritten. - Verbindlicher Domänenname
Es wird empfohlen, einen eigenen Domänennamen zu binden, um einen stabilen Zugang zu gewährleisten.
Verwendung der wichtigsten Funktionen
Testen der API-Nutzbarkeit
- Öffnen Sie die api-check Seite (Online-Version)
https://check.crond.dev
(oder die Adresse für den Selbsteintritt). - Geben Sie die Testparameter ein:
- API-Schlüssel: Füllen Sie den Schlüssel aus, z. B.
sk-xxxx
. - URL: Geben Sie die API-Adresse ein, z. B.
https://api.example.com
. - ModellierungAuswahl von Modellen, z.B.
gpt-4o-mini
. - TimeoutTimeout für die Anfrage festlegen, z. B.
10
Sekunden. - GleichzeitigkeitLegen Sie die Anzahl der gleichzeitigen Anfragen fest, z. B.
2
.
- Klicken Sie auf die Schaltfläche "Test" und warten Sie das Ergebnis ab. Die Schnittstelle wird angezeigt:
- Antwortzeit in Millisekunden.
- Konsistenz des Modells (entspricht es den Erwartungen).
- System-Fingerprinting (zur Überprüfung der API-Authentizität).
Speichern und Laden von Konfigurationen
- Cloud-SpeicherKlicken Sie auf "In der Cloud speichern", geben Sie Ihr Konto und Passwort ein, und die Konfiguration wird auf den Server hochgeladen. Wenn Sie sie das nächste Mal verwenden, klicken Sie auf "Aus der Cloud laden", um sie zu laden.
- lokaler SpeicherKlicken Sie auf "Lokal speichern", um die Konfiguration in Ihrem Browser zu speichern. Wenn Sie die Seite das nächste Mal öffnen, wird sie automatisch geladen.
Schnell-Chat-Test
- Suchen Sie die Option "Quick Chat" in der Benutzeroberfläche.
- Geben Sie eine Testfrage ein, z. B. "Wie viel ist 1+1 gleich?". .
- Klicken Sie auf Senden, um die Ergebnisse der Modellrückgabe zu sehen und die Reaktionsfähigkeit und Genauigkeit zu überprüfen.
- passabel
closeChat: true
Deaktivieren Sie diese Funktion (geeignet für Proxyseiten).
Batch-Test-Taste
- Gehen Sie zum Modul "Experimentelle Funktionen".
- Geben Sie mehrere Schlüssel ein, z.B. GPT Refresh Wertmarken vielleicht Claude Session Keys.
- Klicken Sie auf "Stapeltest" und das Tool wird die Ergebnisse nacheinander überprüfen und anzeigen.
Erweiterte Authentifizierungsfunktionen
- Offizielle Überprüfung des AgentenSendet mehrere identische Anfragen, analysiert die Konsistenz und zeigt die Fingerabdrücke des Systems an.
- Überprüfung der Temperatur: Stellen Sie den Parameter Temperatur auf
0.01
Prüfung der Zufälligkeit und Stabilität des Modells. - Validierung von FunktionsaufrufenTesten, ob das Modell Funktionsaufrufe unterstützt und das richtige Ergebnis liefert.
Beispiel für einen Betriebsprozess
Angenommen, Sie möchten eine OpenAI-Agent-API testen:
- zeigen (eine Eintrittskarte)
https://check.crond.dev
. - Eingabe:
- API-Schlüssel:
sk-test123
. - URL:
https://api.test.com
. - Modelle:
gpt-4o
. - Zeitüberschreitung:
10
Sekunden, konkurrierend:2
.
- Klicken Sie auf "Test", das Ergebnis zeigt eine Reaktionszeit von 300 ms und die Modellkonsistenz ist gegeben.
- Klicken Sie auf "In der Cloud speichern" und geben Sie zum Speichern Ihre Kontonummer ein.
- Wenn Sie es das nächste Mal öffnen, klicken Sie auf "Aus der Cloud laden", um das automatische Laden zu konfigurieren.
- Gehen Sie zu "Quick Chat" und geben Sie "Wie ist das Wetter heute?" ein. und sehen Sie sich die zurückgegebenen Ergebnisse an.
Dieses Verfahren ist einfach und geradlinig und eignet sich für einen schnellen Einstieg.
Anwendungsszenario
- Validierung der API-Leistung
Entwickler müssen prüfen, ob die API stabil ist. api-check zeigt Antwortzeiten und Konsistenz an, um Probleme zu erkennen. - Synchronisierung der Konfiguration mehrerer Geräte
Teams testen APIs auf verschiedenen Geräten. Speichern Sie Konfigurationen in der Cloud, die Mitglieder jederzeit laden können, um die Effizienz zu steigern. - Lernen, Verhalten zu modellieren
Neulinge wollen die Muster der von der API zurückgegebenen Ergebnisse verstehen. Beobachten Sie die Modellleistung durch schnelle Chats und Temperaturvalidierung.
QA
- Erfordert api-check Backend-Unterstützung?
Nicht erforderlich. Es läuft vollständig auf dem Frontend, und die Daten werden nicht auf Server von Dritten hochgeladen. - Welche Modelle werden unterstützt?
Modelle, die hauptsächlich die OpenAI-Agenten-API unterstützen, wie z. B. diegpt-4o-mini
Sie ist auch mit anderen APIs in ähnlichen Formaten kompatibel. - Wie kann ich den Prüfbericht einsehen?
Nach Abschluss des Tests erstellt die Schnittstelle einen Bericht mit Informationen wie Antwortzeit, Konsistenz und Fingerprinting.