Apiboo-Dokumentation

DokuAPIs

Variablen & Umgebungen

Schreib einen Wert einmal als {{name}} und nutze ihn in URLs, Headern, Bodys und Skripten.

Variablen & Umgebungen

Syntax

Schreib einen Namen in doppelte geschweifte Klammern, {{name}}, und nutze ihn überall, wo du einen Request schreibst: in der URL, in Headern, im Body und in Skripten.

Variablen verschachteln

Der Wert einer Variable kann andere Variablen enthalten. {{baseUrl}} kann zum Beispiel

http://localhost:4180/{{apiVersion}}

enthalten, und {{apiVersion}} ist darin eine eigene Variable.

Das Variablen-Popout

Eine Variable, die noch nicht definiert ist, wird rot angezeigt. Klick sie an, und das Popout Add variable öffnet sich genau dort, wo du sie getippt hast:

Das Popout Add variable auf einem unbekannten {{baseUrl}}: das Feld Value und die Auswahl Scope mit Workspace und Global
  1. Tipp die Variable in ein Feld, zum Beispiel {{baseUrl}} in die URL. Sie ist rot, weil sie noch nicht definiert ist.
  2. Klick sie an. Das Popout Add variable öffnet sich.
  3. Gib den Value ein. Er kann andere Variablen enthalten, etwa {{apiVersion}}.
  4. Wähl den Scope, in dem sie liegt (siehe Scopes).

Sobald die Variable definiert ist, wird sie lila.

Scopes

Die Auswahl Scope im Popout legt fest, wo eine neue Variable liegt:

ScopeWas die Auswahl anzeigt
WorkspaceShared across this workspace
GlobalAvailable everywhere

Ordnervariablen

Ein Ordner kann eigene Variablen haben. Sie gelten für jeden Request im Ordner und in seinen Unterordnern und haben Vorrang vor Collection- und Umgebungsvariablen gleichen Namens.

  1. Rechtsklick auf einen Ordner in der Seitenleiste und Ordnervariablen….
  2. Leg in der Tabelle Zeilen an, änder oder deaktivier sie, und klick auf Speichern.

Ist ein Name an mehreren Stellen definiert, gewinnt der erste Treffer in dieser Reihenfolge:

  1. Werte, die ein Skript für dieses Senden gesetzt hat, dann Werte, die ein Skript für die Sitzung gesetzt hat (siehe Mit Variablen arbeiten);
  2. Ordnervariablen, der nächste Ordner zuerst;
  3. Collection-Variablen;
  4. Umgebungsvariablen;
  5. Arbeitsbereichsvariablen;
  6. globale Variablen.

Eine als geheim markierte Ordnervariable wird wie jedes andere Geheimnis behandelt: Der KI-Assistent und MCP sehen ihren Wert nie, und ein Postman- oder Bruno-Export lässt den Wert weg. Skripte lesen Ordnervariablen, können sie aber nicht ändern; ein set im Skript landet stattdessen im Sitzungswert. In einem Team-Arbeitsbereich, in dem du Betrachter bist, öffnet sich die Tabelle nur zum Ansehen.