REST-API-Endpunkte
Caution
Demo-Seite – Dies ist eine Demo-Seite, die die Multi-Tab-Dokumentationsfunktion zeigt. Der Inhalt dient nur zur Veranschaulichung.
Unsere REST-API stellt Endpunkte zum Abrufen und Bearbeiten von Daten bereit. Alle Endpunkte liefern Daten im JSON-Format.
Basis-URL
Alle API-Anfragen sollen an folgende Basis-URL gerichtet werden:
https://api.example.com/v1Users-Endpunkte
Alle Benutzer abrufen
GET /usersGibt eine Liste aller Benutzer zurück. Unterstützt Pagination-Parameter.
Query-Parameter:
| Parameter | Typ | Beschreibung |
|---|---|---|
| page | integer | Seitennummer (Standard: 1) |
| limit | integer | Anzahl der Datensätze pro Seite (Standard: 50, max: 100) |
| sort | string | Feld zum Sortieren (z. B. „name”, „created_at”) |
Antwort:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // Weitere Benutzer ... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Benutzer per ID abrufen
GET /users/{id}Gibt einen einzelnen Benutzer anhand der ID zurück.
Antwort:
{ "data": { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z", "profile": { "bio": "Softwareentwickler:in", "location": "New York", "avatar_url": "https://example.com/avatars/john.jpg" } }}Products-Endpunkte
Alle Produkte abrufen
GET /productsGibt eine Liste aller Produkte zurück. Unterstützt Filterung und Pagination.
Query-Parameter:
| Parameter | Typ | Beschreibung |
|---|---|---|
| category | string | Nach Kategorie filtern |
| min_price | number | Nach Mindestpreis filtern |
| max_price | number | Nach Höchstpreis filtern |
| page | integer | Seitennummer (Standard: 1) |
| limit | integer | Anzahl der Datensätze pro Seite (Standard: 50, max: 100) |
Antwort:
{ "data": [ { "id": "prod_123", "name": "Beispielprodukt", "description": "Das ist ein Beispielprodukt", "price": 49.99, "category": "electronics" }, // Weitere Produkte ... ], "meta": { "total": 350, "page": 1, "limit": 50 }}Fehlerbehandlung
Alle Endpunkte folgen den Standard-HTTP-Statuscodes und liefern bei Bedarf detaillierte Fehlermeldungen:
| Statuscode | Beschreibung |
|---|---|
| 200 | OK – Anfrage erfolgreich |
| 400 | Bad Request – Ungültige Parameter |
| 401 | Unauthorized – Authentifizierung erforderlich |
| 403 | Forbidden – Unzureichende Berechtigungen |
| 404 | Not Found – Ressource existiert nicht |
| 429 | Too Many Requests – Rate-Limit überschritten |
| 500 | Internal Server Error – Serverfehler |
Fehlerantworten enthalten eine Nachricht, die erklärt, was schiefgelaufen ist:
{ "error": { "code": "invalid_parameter", "message": "Der Parameter 'email' ist keine gültige E-Mail-Adresse", "request_id": "req_abc123" }}