Campos

Los campos te ayudan a documentar parámetros de API y campos de respuesta en un formato claro y consistente.

Uso

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

ParamField

Usa ParamField para documentar los parámetros de solicitud de la API. Especifica la ubicación del parámetro usando uno de los siguientes: body, query, path o header.

user_idstringrequired

El identificador único del usuario.

limitnumberdefault: 10

Número máximo de resultados a devolver.

Authorizationstringrequired

Token Bearer para autenticación.

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

Parámetros de ruta

idstringrequired

Identificador del recurso en la ruta URL.

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

Props de ParamField

string

Nombre del parámetro para parámetros de cuerpo.

string

Nombre del parámetro para parámetros de cadena de consulta.

string

Nombre del parámetro para parámetros de ruta URL.

string

Nombre del parámetro para parámetros de encabezado.

string

Tipo de dato (string, number, boolean, array, object).

boolean

Muestra una insignia de "requerido".

string | number | boolean

Valor por defecto cuando no se proporciona.

ResponseField

Usa ResponseField para documentar las propiedades de la respuesta de la API.

idstringrequired

Identificador único del recurso.

created_atstring

Marca de tiempo ISO 8601 de cuándo se creó el recurso.

statusstringdefault: pending

Estado actual de la solicitud.

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

Campos obsoletos

Marca los campos como obsoletos para indicar que serán eliminados en una versión futura:

legacy_idnumberdeprecated

Usa id en su lugar. Este campo será eliminado en v2.

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

Etiquetas

Añade contexto con etiquetas pre y post:

optionalwebhook_urlv2.1+string

URL para recibir notificaciones de Webhook.

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

Objetos anidados

Combina con Expandable para documentar propiedades de objetos anidados:

userobject

El usuario que creó el recurso.

<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 de ResponseField

stringrequired

Nombre del campo.

string

Tipo de dato.

boolean

Muestra una insignia de "requerido".

boolean

Muestra el campo como obsoleto con tachado.

string | number | boolean

Valor por defecto.

string[]

Etiquetas mostradas antes del nombre del campo.

string[]

Etiquetas mostradas después del nombre del campo.

¿Qué sigue?

Descripción general de componentes

Explora todos los componentes disponibles

Conceptos básicos de MDX

Aprende a usar componentes en MDX