---
title: Felder
description: Dokumentieren Sie API-Parameter und Antwortfelder mit den Komponenten ParamField und ResponseField. Unterstützt Typen, Standardwerte und verschachtelte Objekte.
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

Felder helfen Ihnen, API-Parameter und Antwortfelder klar und einheitlich zu dokumentieren.

## Verwendung

```mdx
<ParamField query="limit" type="number" default={10}>
  Maximum number of results to return.
</ParamField>
```

## ParamField

Verwenden Sie `ParamField`, um API-Anfrageparameter zu dokumentieren. Geben Sie den Speicherort des Parameters mit `body`, `query`, `path` oder `header` an.

<ParamField body="user_id" type="string" required>
  Die eindeutige Kennung des Benutzers.
</ParamField>

<ParamField query="limit" type="number" default={10}>
  Die maximale Anzahl zurückzugebender Ergebnisse.
</ParamField>

<ParamField header="Authorization" type="string" required>
  Bearer-Token zur Authentifizierung.
</ParamField>

```mdx
<ParamField body="user_id" type="string" required>
  The unique identifier for the user.
</ParamField>

<ParamField query="limit" type="number" default={10}>
  Maximum number of results to return.
</ParamField>

<ParamField header="Authorization" type="string" required>
  Bearer token for authentication.
</ParamField>
```

### Pfadparameter

<ParamField path="id" type="string" required>
  Ressourcenkennung im URL-Pfad.
</ParamField>

```mdx
<ParamField path="id" type="string" required>
  Resource identifier in the URL path.
</ParamField>
```

### Props von ParamField

<ParamField name="body" type="string">
  Parametername für Body-Parameter.
</ParamField>

<ParamField name="query" type="string">
  Parametername für Query-String-Parameter.
</ParamField>

<ParamField name="path" type="string">
  Parametername für URL-Pfadparameter.
</ParamField>

<ParamField name="header" type="string">
  Parametername für Header-Parameter.
</ParamField>

<ParamField name="type" type="string">
  Datentyp (string, number, boolean, array, object).
</ParamField>

<ParamField name="required" type="boolean">
  Zeigt ein „required“-Badge an.
</ParamField>

<ParamField name="default" type="string | number | boolean">
  Standardwert, wenn kein Wert angegeben wurde.
</ParamField>

## ResponseField

Verwenden Sie `ResponseField`, um Eigenschaften von API-Antworten zu dokumentieren.

<ResponseField name="id" type="string" required>
  Eindeutige Kennung der Ressource.
</ResponseField>

<ResponseField name="created_at" type="string">
  ISO-8601-Zeitstempel der Erstellung der Ressource.
</ResponseField>

<ResponseField name="status" type="string" default="pending">
  Aktueller Status der Anfrage.
</ResponseField>

```mdx
<ResponseField name="id" type="string" required>
  Unique identifier for the resource.
</ResponseField>

<ResponseField name="created_at" type="string">
  ISO 8601 timestamp of when the resource was created.
</ResponseField>

<ResponseField name="status" type="string" default="pending">
  Current status of the request.
</ResponseField>
```

### Veraltete Felder

Markieren Sie Felder als veraltet, um anzugeben, dass sie in einer zukünftigen Version entfernt werden:

<ResponseField name="legacy_id" type="number" deprecated>
  Verwenden Sie stattdessen `id`. Dieses Feld wird in v2 entfernt.
</ResponseField>

```mdx
<ResponseField name="legacy_id" type="number" deprecated>
  Use `id` instead. This field will be removed in v2.
</ResponseField>
```

### Beschriftungen

Fügen Sie mit den Beschriftungen `pre` und `post` zusätzlichen Kontext hinzu:

<ResponseField name="webhook_url" type="string" pre={["optional"]} post={["v2.1+"]}>
  URL zum Empfangen von Webhook-Benachrichtigungen.
</ResponseField>

```mdx
<ResponseField name="webhook_url" type="string" pre={["optional"]} post={["v2.1+"]}>
  URL to receive webhook notifications.
</ResponseField>
```

### Verschachtelte Objekte

Kombinieren Sie `Expandable` mit `ResponseField`, um Eigenschaften verschachtelter Objekte zu dokumentieren:

<ResponseField name="user" type="object">
  Der Benutzer, der die Ressource erstellt hat.
  <Expandable title="Benutzereigenschaften">
    <ResponseField name="id" type="string" required>
      Eindeutige Kennung des Benutzers.
    </ResponseField>
    <ResponseField name="email" type="string" required>
      E-Mail-Adresse des Benutzers.
    </ResponseField>
    <ResponseField name="name" type="string">
      Anzeigename des Benutzers.
    </ResponseField>
  </Expandable>
</ResponseField>

```mdx
<ResponseField name="user" type="object">
  The user who created the resource.
  <Expandable title="user properties">
    <ResponseField name="id" type="string" required>
      User's unique identifier.
    </ResponseField>
    <ResponseField name="email" type="string" required>
      User's email address.
    </ResponseField>
    <ResponseField name="name" type="string">
      User's display name.
    </ResponseField>
  </Expandable>
</ResponseField>
```

### Props von ResponseField

<ParamField name="name" type="string" required>
  Feldname.
</ParamField>

<ParamField name="type" type="string">
  Datentyp.
</ParamField>

<ParamField name="required" type="boolean">
  Zeigt ein „required“-Badge an.
</ParamField>

<ParamField name="deprecated" type="boolean">
  Zeigt das Feld als veraltet mit Durchstreichung an.
</ParamField>

<ParamField name="default" type="string | number | boolean">
  Standardwert.
</ParamField>

<ParamField name="pre" type="string[]">
  Vor dem Feldnamen angezeigte Beschriftungen.
</ParamField>

<ParamField name="post" type="string[]">
  Nach dem Feldnamen angezeigte Beschriftungen.
</ParamField>

## Wie geht es weiter?

<Columns cols={2}>
  <Card title="Übersicht der Komponenten" icon="puzzle-piece" href="/de/components/overview">
    Alle verfügbaren Komponenten durchsuchen
  </Card>
  <Card title="MDX-Grundlagen" icon="file-code" href="/de/content/mdx-basics">
    Erfahren Sie, wie Sie Komponenten in MDX verwenden
  </Card>
</Columns>