Routen und Beispieldaten

Eine Route ist eine Methode und ein Pfad und das, was der Mock dort antwortet. Lege Routen von Hand an, wenn es noch keine Spec gibt, wenn du ein paar Endpunkte zum Entwickeln oder Testen brauchst oder um einen Pfad anders als die Spec zu beantworten. Bodys schreibst du so, wie sie gesendet werden, in JSON, XML oder Text, und sie können Beispieldaten enthalten, die bei jeder Anfrage neu erzeugt werden.

Von Hand angelegte Routen antworten nach den Routen in JavaScript des Mocks und vor den Operationen seiner Spec, falls er eine bereitstellt. Siehe welche Antwort eine Anfrage bekommt.

Route anlegenCopy Anchor Link

Erstelle auf der Seite „Mocks“ mit Neuer Mock einen Mock (er beginnt mit einer Route GET /users mit fünf Beispielnutzern) oder öffne einen beliebigen Mock. Die Karte Routen listet seine Routen:

• Mit dem Kontrollkästchen schaltest du eine Route ab, ohne sie zu löschen; eine abgeschaltete Route antwortet nicht.
• Klicke eine Route an, um sie unter der Liste zu bearbeiten.
• Route hinzufügen fügt eine neue nach der ausgewählten Route ein.
• Klicke eine Route mit der rechten Maustaste an für Duplizieren, Anfrage erstellen, Adresse kopieren (solange der Mock läuft), Nach oben, Nach unten und Route löschen.

Jede Änderung wird sofort gesichert, und ein laufender Mock antwortet sofort damit. Mit Bearbeiten › Widerrufen nimmst du jede Änderung zurück, auch das Löschen einer Route. Haben zwei Routen, die an sind, dieselbe Methode und denselben Pfad, warnt dich die Karte: Nur die erste antwortet.

Methode, Pfad und ZusammenfassungCopy Anchor Link

• Route: die Methode (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS oder ANY für jede Methode) und der Pfad. Eine HEAD-Anfrage geht an eine GET-Route, ohne den Body.
• Pfadparameter schreibst du als {id} oder :id, einen je Teil des Pfads: /users/{id}, /files/{name}.json. :id wird als {id} gesichert. Eine Route mit einem wörtlichen Teil hat Vorrang vor einer mit Parameter, /users/me antwortet also vor /users/{id}.
• Zusammenfassung sagt, wofür die Route da ist. Anfragen, die aus der Route entstehen, übernehmen sie als Namen.

AntwortenCopy Anchor Link

Eine Route hat eine oder mehrere Antworten. Die Chips unter ANTWORTEN wechseln zwischen ihnen; + fügt eine hinzu. Jede Antwort hat:

Die Antwort mit dem Häkchen ist der Standard der Route; Als Standard festlegen bei einer anderen ändert das. Der Papierkorb-Knopf löscht eine Antwort.

Antwort auswählenCopy Anchor Link

Eine Anfrage an eine Route bekommt in dieser Reihenfolge:

1. Die Antwort, die sie verlangt: ein Header Prefer: example=Not found oder Prefer: code=404 oder die Header x-mock-response-name und x-mock-response-code von Postman.
2. Die erste Antwort, deren Regeln alle zutreffen.
3. Den Standard der Route: die Antwort, die du mit Als Standard festlegen zum Standard gemacht hast, egal welche Regeln sie hat. Bei einer Route, bei der du keine gewählt hast, tritt eine erste Antwort, deren Regeln nicht zutrafen, zugunsten der ersten Antwort ohne Regeln zurück, damit ein zuerst aufgeführtes „409 für die versandte Bestellung“ nicht jede andere Bestellung beantwortet.

Eine Regel betrachtet einen Teil der Anfrage:

Der Wert ist der Text, den der Teil haben muss. * steht für jeden Wert, solange es einen gibt; ein leerer Wert bedeutet, dass der Teil fehlen muss. Eine Antwort mit mehreren Regeln antwortet nur, wenn jede zutrifft. Eine Regel ohne Namen wird übersprungen, bis du ihr einen gibst.

Eine Route GET /users/{id} kann zum Beispiel standardmäßig mit 200 und einem Nutzer antworten und eine Antwort 404 mit der Regel Pfadparameter id ist 0 haben:

curl -i http://127.0.0.1:4010/users/42    # 200, the user
curl -i http://127.0.0.1:4010/users/0     # 404

Bodys mit BeispieldatenCopy Anchor Link

Alles in {{ }} in einem Body oder einem Header-Wert wird ausgefüllt, wenn die Anfrage eintrifft, sodass jede Anfrage neue Daten bekommen kann. Der Rest des Bodys wird so gesendet, wie du ihn geschrieben hast.

{
  "id": "{{request.params.id}}",
  "name": "{{$randomFullName}}",
  "email": "{{$randomEmail}}",
  "company": "{{$randomCompanyName}}",
  "joined": "{{$randomDatePast}}"
}

BeispielwerteCopy Anchor Link

{{$randomFirstName}}, {{$randomEmail}}, {{$randomCity}}, {{$randomPrice}}, {{$randomUUID}} und etwa 120 weitere: Namen und Berufe, Internet, Adressen, Telefonnummern, Firmen, Finanzen, Produkte, Datumsangaben, Wörter, Lorem ipsum, Dateien, Bilder und Datenbanken. Die Namen sind die dynamischen Variablen von Postman, Vorlagen für Postman funktionieren hier also. Manche nehmen Argumente: {{$randomInt(1, 100)}}, {{$randomPrice(5, 50)}}, {{$randomLoremWords(5)}}, {{$randomElement(active, paused, closed)}}. Die dynamischen Werte listen jeden einzelnen auf.

Wert einfügen über dem Body setzt einen Beispielwert an die Stelle des Cursors: Beispieldaten enthält sie nach Gruppen.

Dieselben Werte funktionieren in Anfragen, wo sie bei jedem Senden erzeugt werden. Siehe dynamische Werte.

Teile der AnfrageCopy Anchor Link

Wert einfügen › Anfrage enthält sie, mit den eigenen Pfadparametern der Route.

ListenCopy Anchor Link

{{#repeat 10}} … {{/repeat}} schreibt das, was dazwischen steht, so oft; {{#repeat 2 8}} so oft, wie es einer Zahl zwischen den beiden entspricht, bei jeder Anfrage neu gewählt. In einem JSON-Body werden die Elemente für dich mit Kommas getrennt. Innen ist {{@number}} die Nummer des Elements ab 1 und {{@index}} ab 0. Wiederholungen können in Wiederholungen stehen.

[
  {{#repeat 5}}
  {
    "id": {{@number}},
    "name": "{{$randomProductName}}",
    "price": {{$randomPrice}}
  }
  {{/repeat}}
]

Ein {{#repeat}} oder {{/repeat}} allein in einer Zeile hinterlässt keine Leerzeile.

MaskierungCopy Anchor Link

Werte werden für die Stelle maskiert, an der sie landen, sodass ein Name mit Anführungszeichen dein JSON nie zerstört:

• In einem JSON-Body (ein Content-Type mit json) werden Werte innerhalb eines Strings als JSON maskiert. Ein Wert außerhalb von Anführungszeichen, etwa {{$randomInt}} oder {{@number}}, kommt unverändert hinein.
• In XML und HTML (ein Content-Type mit xml oder html) werden &, <, > und Anführungszeichen überall maskiert.
• Dreifache geschweifte Klammern maskieren nie: {{{request.body}}} setzt den JSON-Body der Anfrage als JSON ein.

{ "received": {{{request.body}}}, "at": "{{$isoTimestamp}}" }

Tokens, die Echolot nicht kennt, bleiben so, wie du sie geschrieben hast. Ein Wert, den es nicht erzeugen kann, etwa {{$randomInt(9, 1)}}, bleibt ebenfalls stehen, und das Protokoll sagt, warum. Ein Body endet bei 16 MB und eine Wiederholung bei 10.000 Elementen.

Bodys lesen nichts sonst: keine Variablen, Umgebungen, Secrets oder Dateien des Arbeitsbereichs, sodass ein Mock, der im Netzwerk antwortet, nichts davon preisgeben kann.

Feste Daten: ErzeugenCopy Anchor Link

Werte in {{ }} liefern bei jeder Anfrage neue Daten. Um jedes Mal mit denselben Daten zu antworten, klicke über dem Body auf Erzeugen …:

• Mit Liste erstellen: Der Body ist ein Element wird der Body zu einer JSON-Liste mit so vielen Elementen, jedes aus dem Body erzeugt.
• Ohne die Option werden die Werte des Bodys einmal ausgefüllt.

Erzeugen ersetzt den Body durch das Ergebnis; Bearbeiten › Widerrufen bringt die Vorlage zurück. Im Terminal macht echolot fake dasselbe.

Anfragen aus RoutenCopy Anchor Link

Anfragen erstellen in der Karte Routen legt einen nach dem Mock benannten Ordner mit einer Anfrage für jede Route an, die an ist; Anfrage erstellen im Kontextmenü einer Route legt eine für diese Route an. Echolot öffnet die erste Anfrage.

• Der Ordner hat eine Variable baseUrl, die auf die Adresse des Mocks zeigt, und jede URL beginnt damit: {{baseUrl}}/users/{{id}}. Richte baseUrl später auf die echte API, und dieselben Anfragen gehen dorthin.
• Pfadparameter werden zu Anfragevariablen, 1, sofern keine Pfadregel der Standardantwort einen Wert nennt.
• Die Anfrage heißt wie die Zusammenfassung der Route.
• Der Anfrage-Body der Route kommt mit.

Der Anfrage-Body einer RouteCopy Anchor Link

Anfrage-Body unten in einer Route enthält einen Body und seinen Content-Type für die Anfragen, die aus der Route entstehen, etwa das JSON, das ein POST /users annimmt. Er ändert nicht, was der Mock antwortet; Regeln für Body-Felder lesen, was Anfragen tatsächlich senden.

Mit AgentenCopy Anchor Link

Ist das Tool-Set Mocks an, legen Agenten und der Assistent ebenfalls Routen an. Bitte um das, was du brauchst:

• „Erstelle einen Mock mit Routen zum Auflisten, Lesen und Anlegen von Bestellungen, mit Beispieldaten, und starte ihn.“
• „Füge GET /users/{id} eine 404 hinzu, wenn die ID 0 ist.“
• „Erstelle Anfragen für die Routen des Mocks.“

Sie verwenden create_mock (mit einem Namen und Routen, eine Spec ist nicht nötig), save_mock_route, delete_mock_route, generate_fake_data, list_fake_values und create_requests_from_mock. save_mock_route kann auch eine Antwort aus dem Verlauf in eine Route verwandeln; was es kopiert, ist maskiert wie alles, was Agenten lesen. Löscht ein Agent eine Route, fragt er vorher bei dir nach. Siehe Agenten.

Im ArbeitsbereichCopy Anchor Link

Routen liegen in der Datei des Mocks, mocks/<name>.toml, als [[routes]] mit ihren [[routes.responses]]: lesbar in einem Diff und über Git geteilt. Siehe Arbeitsbereichsdateien.