Code-Schublade
2 min
Code-Schublade Blöcke zeigen Anfragebeispiele und Antwortbeispiele in der rechten Spalte eines zweispaltigen Layouts an. Verwenden Sie sie, um interaktive API-Dokumentation zu erstellen.
Syntax
Sie können diese Komponente entweder mit Markdown oder MDX hinzufügen.
::::CodeDrawer{title="Endpoint Name"}
:::CodeblockTabsExamples
(Code blocks with request examples)
:::
:::CodeblockTabsResponses
(Code blocks with response examples)
:::
::::Eine Code-Schublade besteht aus zwei Abschnitten:
- CodeblockTabsExamples für Anfragebeispiele.
- CodeblockTabsAntworten für Antwortbeispiele.
Jeder Abschnitt kann einen oder mehrere eingezäunte Codeblöcke enthalten. Wenn mehrere Codeblöcke vorhanden sind, werden sie automatisch in Sprach-Tabs gruppiert.
Code-Schubladen werden in der rechten Spalte angezeigt, wenn sie innerhalb eines zweispaltigen Layouts verwendet werden.
MDX-Beispiel
Das folgende Beispiel erstellt eine Code-Schublade mit Anfragebeispielen in JavaScript, Python und Bash sowie erfolgreichen und Fehlerantworten.
<CodeDrawer title="Create a User">
<CodeblockTabsExamples>
```javascript
const response = await fetch('https://api.example.com/users', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer sk_live_xxx'
},
body: JSON.stringify({
name: 'Jane Doe',
email: '[email protected]',
role: 'admin'
})
})
const user = await response.json()
```
```python
import requests
response = requests.post('https://api.example.com/users', json={
'name': 'Jane Doe',
'email': '[email protected]',
'role': 'admin'
}, headers={
'Authorization': 'Bearer sk_live_xxx'
})
user = response.json()
```
```bash
curl -X POST https://api.example.com/users \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk_live_xxx" \
-d '{"name":"Jane Doe","email":"[email protected]","role":"admin"}'
```
</CodeblockTabsExamples>
<CodeblockTabsResponses>
```json
{
"id": "usr_abc123",
"name": "Jane Doe",
"email": "[email protected]",
"role": "admin",
"createdAt": "2026-04-01T10:00:00Z"
}
```
```json
{
"error": "Validation failed",
"message": "Email already exists",
"code": 409
}
```
</CodeblockTabsResponses>
</CodeDrawer>Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.