Sections extensibles

Utilisez le composant extensible pour afficher ou masquer les propriétés imbriquées dans la documentation d’API, en exposant les champs enfants des objets de requête et de réponse.

Utilisez des sections extensibles pour afficher ou masquer du contenu imbriqué dans les champs de réponse. Elles sont particulièrement utiles pour présenter des propriétés d’objet complexes dans la documentation d’API.

user · User Object

Afficher propriétés

full_name · string

Le nom complet de l’utilisateur

is_over_21 · boolean

Indique si l’utilisateur a plus de 21 ans

Expandable example

<ResponseField name="user" type="User Object">
  <Expandable title="propriétés">
    <ResponseField name="full_name" type="string">
      Le nom complet de l'utilisateur
    </ResponseField>

    <ResponseField name="is_over_21" type="boolean">
      Indique si l'utilisateur a plus de 21 ans
    </ResponseField>
  </Expandable>
</ResponseField>

​

Propriétés

title · string

Le nom de l’objet affiché.

defaultOpen · boolean · défaut: "false"

Définissez sur true pour que l’élément extensible s’ouvre au chargement de la page.

className · string

Classes CSS supplémentaires à appliquer à l’élément extensible.