<RequestExample>
und <ResponseExample>
zeigen Codeblöcke in der rechten Seitenleiste an und erzeugen so ein zweispaltiges Layout, das Beispiele sichtbar hält, während Nutzer durch die Inhalte scrollen. Diese Komponenten sind für API-Dokumentation konzipiert, funktionieren aber auf allen Seiten.
Häufige Anwendungsfälle:
- API-Endpunktdokumentation mit Request- und Response-Beispielen
- Konfigurationsbeispiele neben erklärendem Text
- Codebeispiele, auf die sich Nutzer beim Befolgen von Anweisungen beziehen
- Vorher-/Nachher-Beispiele in Tutorials
<RequestExample>
- und <ResponseExample>
-Komponenten als reguläre Codeblöcke angezeigt und können einfach weitergescrollt werden.
RequestExample
<RequestExample>
, um Codebeispiele in der rechten Seitenleiste anzupinnen. Diese Komponente funktioniert ähnlich wie CodeGroup, zeigt den Code jedoch in der Seitenleiste statt inline an.
Sie können mehrere Codeblöcke in einem einzigen <RequestExample>
einfügen. Jeder Codeblock muss ein title-Attribut besitzen.
RequestExample
ResponseExample
<ResponseExample>
heftet Codebeispiele in der rechten Seitenleiste unterhalb sämtlicher <RequestExample>
-Inhalte auf derselben Seite an.
ResponseExample