> ## Documentation Index
> Fetch the complete documentation index at: https://smartac-justin-client-exports.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Campos

> Usa los componentes ParamField y ResponseField para documentar parámetros de solicitud y respuesta de la API con tipos, valores por defecto y validación.

Usa campos para documentar los parámetros y las respuestas de la API. Hay dos tipos de campos: campos de parámetro y campos de respuesta.

<div id="parameter-field">
  ## Campo de parámetro
</div>

Usa el componente `<ParamField>` para definir parámetros de tus API o SDK. Al agregar un `ParamField`, se añade automáticamente un [área de pruebas de la API](/es/api-playground/overview).

<ParamField path="param" type="string" required>
  Un ejemplo de campo de parámetro
</ParamField>

```mdx theme={null}
<ParamField path="param" type="string" required>
  Un ejemplo de un campo de parámetro
</ParamField>
```

<div id="properties">
  ### Propiedades
</div>

<ParamField body="query, path, body, or header" type="string">
  Indica si el parámetro es de query, ruta, cuerpo o encabezado. Seguido del
  nombre del parámetro.
</ParamField>

<ParamField body="type" type="string">
  Tipo esperado del valor del parámetro.

  Admite `number`, `string`, `boolean`, `object`.

  Define los arreglos con el sufijo `[]`. Por ejemplo, `string[]`.
</ParamField>

<ParamField body="required" type="boolean">
  Indica si requieres el parámetro.
</ParamField>

<ParamField body="deprecated" type="boolean">
  Indica si has marcado el parámetro como obsoleto.
</ParamField>

<ParamField body="default" type="any">
  Valor predeterminado que se aplica cuando el valor de la solicitud está vacío.
</ParamField>

<ParamField body="placeholder" type="string">
  Texto del marcador de posición para la entrada en el entorno de pruebas.
</ParamField>

<ParamField body="children" type="string">
  Descripción del parámetro (compatible con Markdown).
</ParamField>

<div id="response-field">
  ## Campo de respuesta
</div>

El componente `<ResponseField>` define los valores de retorno de una API.

<ResponseField name="response" type="string" required>
  Un ejemplo de un campo de respuesta
</ResponseField>

```mdx theme={null}
<ResponseField name="response" type="string" required>
  Un ejemplo de campo de respuesta
</ResponseField>
```

<div id="properties">
  ### Propiedades
</div>

<ResponseField name="name" type="string" required>
  El nombre del valor de la respuesta.
</ResponseField>

<ResponseField name="type" type="string" required>
  Tipo esperado del valor de la respuesta. Puede ser cualquier cadena arbitraria.
</ResponseField>

<ResponseField name="default" type="string">
  Valor predeterminado.
</ResponseField>

<ResponseField name="required" type="boolean">
  Indica si requieres la respuesta.
</ResponseField>

<ResponseField name="deprecated" type="boolean">
  Indica si has marcado un campo como obsoleto.
</ResponseField>

<ResponseField name="pre" type="string[]">
  Etiquetas que aparecen antes del nombre del campo.
</ResponseField>

<ResponseField name="post" type="string[]">
  Etiquetas que aparecen después del nombre del campo.
</ResponseField>