---
title: Campi
description: Documenta i parametri API e i campi della risposta con i componenti ParamField e ResponseField. Supporta tipi, valori predefiniti e oggetti nidificati.
---

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

I campi consentono di documentare i parametri API e i campi della risposta in un formato chiaro e coerente.

## Utilizzo

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

## ParamField

Usa `ParamField` per documentare i parametri della richiesta API. Specifica la posizione del parametro usando uno tra `body`, `query`, `path` o `header`.

<ParamField body="user_id" type="string" required>
  L'identificatore univoco dell'utente.
</ParamField>

<ParamField query="limit" type="number" default={10}>
  Numero massimo di risultati da restituire.
</ParamField>

<ParamField header="Authorization" type="string" required>
  Token Bearer per l'autenticazione.
</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>
```

### Parametri del percorso

<ParamField path="id" type="string" required>
  Identificatore della risorsa nel percorso dell'URL.
</ParamField>

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

### Proprietà di ParamField

<ParamField name="body" type="string">
  Nome del parametro per i parametri del body.
</ParamField>

<ParamField name="query" type="string">
  Nome del parametro per i parametri della stringa di query.
</ParamField>

<ParamField name="path" type="string">
  Nome del parametro per i parametri del percorso dell'URL.
</ParamField>

<ParamField name="header" type="string">
  Nome del parametro per i parametri dell'header.
</ParamField>

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

<ParamField name="required" type="boolean">
  Mostra un badge "required".
</ParamField>

<ParamField name="default" type="string | number | boolean">
  Valore predefinito quando non viene fornito.
</ParamField>

## ResponseField

Usa `ResponseField` per documentare le proprietà della risposta API.

<ResponseField name="id" type="string" required>
  Identificatore univoco della risorsa.
</ResponseField>

<ResponseField name="created_at" type="string">
  Timestamp ISO 8601 della creazione della risorsa.
</ResponseField>

<ResponseField name="status" type="string" default="pending">
  Stato attuale della richiesta.
</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>
```

### Campi obsoleti

Contrassegna i campi come obsoleti per indicare che verranno rimossi in una versione futura:

<ResponseField name="legacy_id" type="number" deprecated>
  Usa `id` al suo posto. Questo campo verrà rimosso nella versione v2.
</ResponseField>

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

### Etichette

Aggiungi contesto con le etichette `pre` e `post`:

<ResponseField name="webhook_url" type="string" pre={["optional"]} post={["v2.1+"]}>
  URL per ricevere le notifiche del Webhook.
</ResponseField>

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

### Oggetti nidificati

Combina `ResponseField` con `Expandable` per documentare le proprietà degli oggetti nidificati:

<ResponseField name="user" type="object">
  L'utente che ha creato la risorsa.
  <Expandable title="proprietà dell'utente">
    <ResponseField name="id" type="string" required>
      Identificatore univoco dell'utente.
    </ResponseField>
    <ResponseField name="email" type="string" required>
      Indirizzo email dell'utente.
    </ResponseField>
    <ResponseField name="name" type="string">
      Nome visualizzato dell'utente.
    </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>
```

### Proprietà di ResponseField

<ParamField name="name" type="string" required>
  Nome del campo.
</ParamField>

<ParamField name="type" type="string">
  Tipo di dati.
</ParamField>

<ParamField name="required" type="boolean">
  Mostra un badge "required".
</ParamField>

<ParamField name="deprecated" type="boolean">
  Mostra il campo come obsoleto con testo barrato.
</ParamField>

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

<ParamField name="pre" type="string[]">
  Etichette visualizzate prima del nome del campo.
</ParamField>

<ParamField name="post" type="string[]">
  Etichette visualizzate dopo il nome del campo.
</ParamField>

## Cosa fare dopo

<Columns cols={2}>
  <Card title="Panoramica dei componenti" icon="puzzle-piece" href="/it/components/overview">
    Esplora tutti i componenti disponibili
  </Card>
  <Card title="Nozioni di base su MDX" icon="file-code" href="/it/content/mdx-basics">
    Scopri come usare i componenti in MDX
  </Card>
</Columns>