Import aus OpenAPI / Swagger

Wenn Sie Ihre API bereits mit einer OpenAPI-3.x- oder Swagger-2.0-Spezifikation beschreiben, müssen Sie nicht jeden Endpunkt von Hand in LoadFocus nachbauen. Importieren Sie die Spezifikation, und LoadFocus erzeugt einen API-Monitor pro Operation — Methode, URL und eine Statuscode-Prüfung — in einem einzigen Schritt.

Es funktioniert mit OpenAPI 3.x und Swagger 2.0, als JSON oder YAML, und läuft vollständig in Ihrem Konto und Ihrem aktiven Team, wobei Ihre Plan-Limits genau wie im Dashboard durchgesetzt werden.

So funktioniert es

1. Öffnen Sie API Monitoring und gehen Sie zur Liste der Checks.
2. Klicken Sie auf Aus OpenAPI importieren.
3. Entweder fügen Sie den Spezifikationstext ein oder geben eine URL an, die LoadFocus für Sie lädt.
4. Wählen Sie die Häufigkeit und ob die importierten Checks aktiv starten.
5. Klicken Sie auf Importieren. LoadFocus liest die Spezifikation und erstellt für jede Operation einen Check.

Für jede Operation erstellt LoadFocus:

• die Anfrage-URL aus servers der Spezifikation (OpenAPI 3) oder schemes + host + basePath (Swagger 2), verbunden mit dem Operationspfad;
• die HTTP-Methode (GET, POST, PUT, PATCH, DELETE …);
• eine Statuscode-Prüfung — den dokumentierten Erfolgscode, wenn die Spezifikation einen angibt, sonst „Status ist unter 400";
• einen lesbaren Namen aus der operationId der Operation (oder METHODE /pfad).

Pfadparameter wie /users/{id} werden mit dem example-, default- oder ersten enum-Wert des Parameters gefüllt, sofern die Spezifikation einen liefert, sonst mit einem Platzhalter. Prüfen Sie diese Checks nach dem Import, damit sie auf eine echte Ressource zeigen.

Quelle: Einfügen oder URL

• Einfügen — kopieren Sie Ihre openapi.json, openapi.yaml, swagger.json oder swagger.yaml in das Feld. JSON und YAML werden beide akzeptiert. Spezifikationen bis zu einigen Megabyte werden unterstützt.
• URL — geben Sie die öffentliche Adresse Ihrer Spezifikation an (zum Beispiel https://api.example.com/openapi.json). LoadFocus lädt sie über HTTPS. Interne oder private Adressen werden abgelehnt.

Basis-URL

LoadFocus liest die Basis-URL aus der Spezifikation. Wenn die Spezifikation keinen Server angibt (oder Sie die Checks woanders hinrichten möchten, etwa auf einen Staging-Host), füllen Sie Basis-URL überschreiben aus — zum Beispiel https://api.example.com.

Häufigkeit und Aktivierung

• Häufigkeit — wie oft jeder importierte Check läuft (standardmäßig 5 Minuten).
• Importierte Checks aktivieren — wenn aktiviert, starten die Checks sofort. Schalten Sie es aus, um sie pausiert zu importieren, zu prüfen und nur die gewünschten zu aktivieren. Das ist nützlich, wenn Ihre Spezifikation Schreiboperationen (POST, PUT, DELETE) enthält, die ein geplanter Monitor nicht wiederholt aufrufen soll.

Was Sie nach dem Import prüfen sollten

• Schreiboperationen — ein geplanter Monitor ruft den Endpunkt bei jedem Lauf auf. Bestätigen Sie bei POST / PUT / PATCH / DELETE, dass Sie sie wirklich überwachen möchten, oder importieren Sie pausiert und aktivieren nur die sicheren.
• Pfadparameter — stellen Sie sicher, dass ersetzte Werte auf eine vorhandene Ressource zeigen.
• Authentifizierung — importierte Checks haben keine Zugangsdaten. Fügen Sie Header, einen API-Schlüssel oder ein Token über Secrets und Variablen hinzu, damit authentifizierte Endpunkte ihren echten Status zurückgeben.
• Anfrage-Bodies — wenn die Spezifikation einen Beispiel-Body enthält, wird er verwendet; sonst wird die Anfrage ohne gesendet.

Plan-Limits

Importierte Checks zählen zum API-Monitor-Limit Ihres Plans, genau wie von Hand erstellte Checks. Hat eine Spezifikation mehr Operationen als Ihr verbleibendes Kontingent, erstellt LoadFocus so viele wie möglich und meldet, wie viele erstellt und wie viele übersprungen wurden — nichts wird über Ihren Plan hinaus still erstellt.

Monitore synchron halten

Ein einmaliger Import ist ein schneller Einstieg. Wenn Ihre Monitore mit Ihrer API-Definition dauerhaft im Gleichschritt bleiben sollen, verwalten Sie sie als versionierte Dateien mit Monitoring as Code und gleichen Sie sie aus CI ab.