Desplegables

Usa el componente expandable para mostrar u ocultar propiedades anidadas en la documentación de API, mostrando campos secundarios de objetos de solicitud y respuesta.

Usa desplegables para mostrar y ocultar contenido anidado dentro de los campos de respuesta. Son especialmente útiles para mostrar propiedades de objetos complejas en la documentación de la API.

user · User Object

Mostrar properties

full_name · string

El nombre completo del usuario

is_over_21 · boolean

Indica si el usuario tiene más de 21 años

Expandable example

<ResponseField name="user" type="User Object">
  <Expandable title="properties">
    <ResponseField name="full_name" type="string">
      El nombre completo del usuario
    </ResponseField>

    <ResponseField name="is_over_21" type="boolean">
      Indica si el usuario tiene más de 21 años
    </ResponseField>
  </Expandable>
</ResponseField>

​

Propiedades

title · string

El nombre del objeto que se muestra.

defaultOpen · boolean · predeterminado: "false"

Configúralo en true para que el elemento expandible se abra al cargar la página.

className · string

Clases CSS adicionales que se aplican al elemento expandible.