Quickstart: deine erste Simulation
In wenigen Minuten hast du eine gehostete Mock-API unter einer URL, die dein ganzes Team aufrufen kann. Alles passiert im Browser; es gibt nichts zu installieren.
Simulation erstellen
Melde dich an und öffne Simulationen. Klicke auf den Pfeil neben Neue Simulation und wähle Beispiel-Simulation erstellen.
Das Beispiel ist der schnellste Einstieg: Es kommt vorbefüllt mit der Petstore-OpenAPI-Spec und ein paar statischen Endpunkten, es gibt also nichts zu konfigurieren.
Siehe Simulation erstellen für die anderen Wege: leer starten, eine API aus dem Katalog wählen oder deine eigene Spec mitbringen.
Deployen
Die Simulation öffnet sich in der Endpunkte-Ansicht und listet alles, was sie ausliefern wird, gruppiert nach Dienst.
Klicke auf Deploy. Nach ein paar Sekunden springt der Status auf Aktiv und die URL der Simulation erscheint unter der Kopfzeile.
Im Browser erkunden
Jede deployte Simulation liefert unter ihrer URL einen eingebauten API-Explorer aus. Öffne die URL im Browser, um Dienste und Endpunkte zu sehen; ein Klick auf einen Endpunkt schickt eine Anfrage und zeigt die generierte Antwort.
Der Explorer lässt sich abschalten, und die ganze Simulation kann hinter Zugangsdaten oder einen erlaubten IP-Bereich gelegt werden.
Siehe Zugriffskontrolle.
Aufrufen
Kopiere die URL und rufe einen der Endpunkte auf. Dein Pfad trägt deine eigene Organisation und deinen Simulationsnamen:
curl "https://api.mockz.io/app/docs-shots/tidy-valley/petstore/pets?limit=1"Die Antwort wird aus den Schemas der Spec generiert, mit frischen Werten bei jedem Aufruf:
{
"nextPageToken": "cvdzxtlsan",
"pets": [
{
"birthDate": "1994-08-09",
"breed": "Labrador",
"id": "6f5c3020-25f7-4617-86af-f2039c82e986",
"name": "Marley",
"ownerEmail": "charley@xbn.com",
"ownerName": "Glen Streich",
"species": "rabbit",
"status": "sold",
"weightKg": 48
}
]
}Anfragen werden auch validiert: Ein Body, der die Spec verletzt, wird abgelehnt, so wie die echte API ihn ablehnen würde.
Nachsehen, was passiert ist
Öffne Verlauf in der Seitenleiste der Simulation, unter Aufzeichnungen, und wähle den Dienst petstore. Jeder Aufruf steht dort mit Methode, Pfad, Status und Dauer. Klicke einen an, um Anfrage und Antwort im Detail zu sehen.
Offline nehmen
Wenn du fertig bist, klicke auf den Pfeil neben Deploy und wähle Offline nehmen. Die Simulation liefert nichts mehr aus und ihre URL ist nicht mehr erreichbar; ein neues Deploy bringt sie unverändert zurück.