Beispiele

Diese Komponenten fixieren Codeblöcke auf dem Desktop in einer festen rechten Seitenleiste. Der Code bleibt beim Scrollen sichtbar. Auf mobilen Geräten werden die Blöcke inline dargestellt.

RequestExample

Verwenden Sie RequestExample, um API-Request-Code anzuzeigen. Jeder zusätzliche Codeblock fügt einen Tab hinzu.

curl -X POST https://api.example.com/users \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "John Doe", "email": "john@example.com"}'

Verwendung:

<RequestExample>
```bash cURL
curl -X POST https://api.example.com/users \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "John Doe", "email": "john@example.com"}'
```
</RequestExample>

ResponseExample

Verwenden Sie ResponseExample, um API-Antworten anzuzeigen. Fügen Sie nach dem Sprachbezeichner einen Statuscode und eine Beschreibung hinzu.

{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2024-01-15T10:30:00Z"
}

Verwendung:

<ResponseExample>
```json 200: Success
{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2024-01-15T10:30:00Z"
}
```
</ResponseExample>

Der Statuscode bestimmt die Farbe der Anzeige:

• Grün: 2xx-Erfolgscodes
• Blau: 3xx-Weiterleitungscodes
• Gelb: 4xx-Client-Fehler
• Rot: 5xx-Server-Fehler

Mehrere Programmiersprachen

Fügen Sie mehrere Codeblöcke hinzu, um Tabs zu erhalten:

curl -X GET https://api.example.com/users/123 \
  -H "Authorization: Bearer $TOKEN"

Verwendung:

<RequestExample>
```bash cURL
curl -X GET https://api.example.com/users/123 \
  -H "Authorization: Bearer $TOKEN"
```

```python Python
import requests

response = requests.get(
    "https://api.example.com/users/123",
    headers={"Authorization": f"Bearer {TOKEN}"}
)
user = response.json()
```

```javascript JavaScript
const response = await fetch("https://api.example.com/users/123", {
  headers: {
    "Authorization": `Bearer ${TOKEN}`
  }
});
const user = await response.json();
```

```go Go
package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.example.com/users/123", nil)
  req.Header.Set("Authorization", "Bearer TOKEN")

  resp, _ := (&http.Client{}).Do(req)
  defer resp.Body.Close()

  body, _ := io.ReadAll(resp.Body)
  fmt.Println(string(body))
}
```

```ruby Ruby
require 'net/http'
require 'uri'
require 'json'

uri = URI("https://api.example.com/users/123")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer TOKEN"

response = http.request(request)
puts JSON.parse(response.body)
```
</RequestExample>

Mehrere Antwortcodes

Zeigen Sie jeden Antwortcode in einem eigenen Tab:

{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com"
}

Verwendung:

<ResponseExample>
```json 200: Success
{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com"
}
```

```json 400: Bad Request
{
  "error": "validation_error",
  "message": "Email is required"
}
```

```json 404: Not Found
{
  "error": "not_found",
  "message": "User not found"
}
```
</ResponseExample>

Kombinierte Verwendung

Verwenden Sie RequestExample und ResponseExample gemeinsam auf einer API-Seite. Der Request erscheint in der Seitenleiste oberhalb der Antwort:

curl -X POST https://api.example.com/orders \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "prod_456",
    "quantity": 2
  }'

{
  "id": "ord_789",
  "product_id": "prod_456",
  "quantity": 2,
  "status": "pending",
  "created_at": "2024-01-15T10:30:00Z"
}

Verwendung:

<RequestExample>
```bash cURL
curl -X POST https://api.example.com/orders \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "prod_456",
    "quantity": 2
  }'
```
</RequestExample>

<ResponseExample>
```json 201: Created
{
  "id": "ord_789",
  "product_id": "prod_456",
  "quantity": 2,
  "status": "pending",
  "created_at": "2024-01-15T10:30:00Z"
}
```
</ResponseExample>

Formate für Statuscodes

ResponseExample akzeptiert zwei Formate für Statuscodes:

```json 200: Success      // Colon separator

```json 400 - Bad Request // Dash separator

Jamdesk verarbeitet beide gleich. Der Tab zeigt den Statuscode und seine Beschreibung.

Wie geht es weiter?