Eingabe-Schema und Feldtypen

Ein Eingabe-Schema beschreibt, welche Angaben jemand mitschicken muss, um deine API zu nutzen. Stell dir vor, deine API liefert Wetterdaten — dann braucht sie vermutlich eine Stadt und vielleicht ein Datum. Genau das trägst du hier ein.

Für jede Angabe legst du fest:

• einen Namen (zum Beispiel stadt oder datum),
• einen Typ (zum Beispiel Text für eine Stadt oder Datum für ein Datum),
• ob die Angabe zwingend nötig ist (Pflicht).

So wissen sowohl Menschen als auch automatische Programme genau, was sie an deine API schicken müssen. Ein Ausgabe-Schema funktioniert genauso — nur beschreibt es, was deine API zurückgibt (zum Beispiel temperatur als Zahl).

Wenn du dich technisch auskennst, kannst du im Formular auf JSON direkt eingeben umschalten und das Schema selbst im JSON-Format angeben.

Feldtypen

Beim Beschreiben deiner Ein- und Ausgaben wählst du für jede Angabe einen Typ. Der Typ sagt, welche Art von Wert erwartet wird. Hier die wichtigsten:

• Text — für Wörter oder Sätze, zum Beispiel ein Stadtname wie Hamburg.
• Zahl — für Zahlenwerte, zum Beispiel eine Temperatur (21) oder einen Preis.
• Datum — für ein Kalenderdatum, zum Beispiel 2025-06-16.
• Boolean (Ja/Nein) — für einfache Wahr/Falsch-Angaben, zum Beispiel aktiv: ja.
• E-Mail — für eine E-Mail-Adresse. Das Format prüft das Gateway nicht.
• URL — für eine Internet-Adresse, zum Beispiel https://….

Wähle den Typ, der am besten zu deiner Angabe passt. Im Zweifel ist Text immer eine sichere Wahl.