Saltar al contenido principal
<ResponseField name="response" type="string" required>
  Un ejemplo de campo de respuesta
</ResponseField>
El componente <ResponseField> está diseñado para definir los valores que devuelve una API. Muchos documentos también utilizan <ResponseField> en páginas cuando necesitas listar los tipos de algo.
​
response
string
required
Un ejemplo de campo de respuesta
<ResponseField name="response" type="string" required>
  Un ejemplo de campo de respuesta
</ResponseField>

​
Props

​
name
string
required
El nombre del valor de la respuesta.
​
type
string
required
Tipo esperado del valor de la respuesta: puede ser cualquier cadena arbitraria.
​
default
string
El valor predeterminado.
​
required
boolean
Mostrar “required” junto al nombre del campo.
​
deprecated
boolean
Indica si un campo está en desuso.
​
pre
string[]
Etiquetas que se muestran antes del nombre del campo
​
post
string[]
Etiquetas que se muestran después del nombre del campo
<ResponseField name="response" type="string" required>
  Un ejemplo de campo de respuesta
</ResponseField>
⌘I