Verwenden Sie Felder, um API-Parameter und -Antworten zu dokumentieren. Es gibt zwei Arten von Feldern: Parameterfelder und Antwortfelder.

​
Parameterfeld

Die <ParamField>-Komponente wird verwendet, um Parameter für Ihre APIs oder SDKs zu definieren. Das Hinzufügen eines ParamField fügt automatisch eine API-Spielwiese hinzu.
​
param
string
required
Ein Beispiel für ein Parameterfeld
<ParamField path="param" type="string" required>
  Ein Beispiel für ein Parameterfeld
</ParamField>

​
Eigenschaften

​
query, path, body, or header
string
Gibt an, ob es sich beim Parameter um einen Query-, Path-, Body- oder Header-Parameter handelt. Danach folgt der Parametername.
​
type
string
Erwarteter Typ des Parameterwerts.Unterstützt number, string, boolean, object.Arrays können mit dem Suffix [] definiert werden, z. B. string[].
​
required
boolean
Gibt an, ob der Parameter erforderlich ist.
​
deprecated
boolean
Gibt an, ob der Parameter veraltet ist.
​
default
any
Standardwert, der verwendet wird, wenn der Anforderungswert leer ist
​
placeholder
string
Platzhaltertext für die Eingabe in der API-Spielwiese.
​
children
string
Beschreibung des Parameters (Markdown-unterstützt).

​
Response-Feld

Die <ResponseField>-Komponente definiert die Rückgabewerte einer API.
​
response
string
required
Ein Beispiel für ein Response-Feld
<ResponseField name="response" type="string" required>
  Ein Beispiel für ein Response-Feld
</ResponseField>

​
Eigenschaften

​
name
string
required
Der Name des Responsewerts.
​
type
string
required
Erwarteter Typ des Responsewerts. Dies kann eine beliebige Zeichenfolge sein.
​
default
string
Der Standardwert.
​
required
boolean
Gibt an, ob die Response erforderlich ist.
​
deprecated
boolean
Ob ein Feld als veraltet markiert ist.
​
pre
string[]
Labels, die vor dem Feldnamen angezeigt werden.
​
post
string[]
Labels, die nach dem Feldnamen angezeigt werden.