Felder

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

Verwendung

<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.

user_idstringrequired

Die eindeutige Kennung des Benutzers.

limitnumberdefault: 10

Die maximale Anzahl zurückzugebender Ergebnisse.

Authorizationstringrequired

Bearer-Token zur Authentifizierung.

<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

idstringrequired

Ressourcenkennung im URL-Pfad.

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

Props von ParamField

string

Parametername für Body-Parameter.

string

Parametername für Query-String-Parameter.

string

Parametername für URL-Pfadparameter.

string

Parametername für Header-Parameter.

string

Datentyp (string, number, boolean, array, object).

boolean

Zeigt ein „required“-Badge an.

string | number | boolean

Standardwert, wenn kein Wert angegeben wurde.

ResponseField

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

idstringrequired

Eindeutige Kennung der Ressource.

created_atstring

ISO-8601-Zeitstempel der Erstellung der Ressource.

statusstringdefault: pending

Aktueller Status der Anfrage.

<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:

legacy_idnumberdeprecated

Verwenden Sie stattdessen id. Dieses Feld wird in v2 entfernt.

<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:

optionalwebhook_urlv2.1+string

URL zum Empfangen von Webhook-Benachrichtigungen.

<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:

userobject

Der Benutzer, der die Ressource erstellt hat.

<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

stringrequired

Feldname.

string

Datentyp.

boolean

Zeigt ein „required“-Badge an.

boolean

Zeigt das Feld als veraltet mit Durchstreichung an.

string | number | boolean

Standardwert.

string[]

Vor dem Feldnamen angezeigte Beschriftungen.

string[]

Nach dem Feldnamen angezeigte Beschriftungen.

Wie geht es weiter?

Übersicht der Komponenten

Alle verfügbaren Komponenten durchsuchen

MDX-Grundlagen

Erfahren Sie, wie Sie Komponenten in MDX verwenden