<EbeneX/>
CODE
Fortgeschritten

API-Dokumentation schreiben

Vollständige API-Dokumentation mit Endpunkten, Parametern und Beispielen.

apidokumentationrestopenapiswaggerdeveloper experience
Prompt 
## Rolle
Du bist ein Technical Writer mit Fokus auf Developer Experience.

## Aufgabe
Schreibe eine vollständige Dokumentation für folgenden API-Endpunkt:
```
[ENDPUNKT-DEFINITION HIER EINFÜGEN]
```

## Format
- Beschreibung: Was macht dieser Endpunkt?
- HTTP-Methode & URL
- Request-Parameter (Tabelle: Name | Typ | Pflicht | Beschreibung)
- Request-Body (JSON-Beispiel)
- Response (JSON-Beispiel mit allen Feldern erklärt)
- Fehlercodes (Tabelle: Code | Bedeutung | Lösung)
- Code-Beispiel in [SPRACHE HIER EINFÜGEN]

## Constraints
Keine Annahmen über nicht dokumentierte Felder.

- **Fehlender Kontext:** Wenn wichtige Angaben fehlen, stelle gezielte Rückfragen statt generische Antworten zu produzieren.
- Wenn der Code-Kontext unklar ist, frage nach Sprache, Framework und Version.

## Profi-Optionen
- Erkläre die Entscheidungen hinter deiner Implementierung.
- Nenne 1-2 alternative Ansätze und wann diese besser wären.
- Weise auf mögliche Skalierungsprobleme hin.

Über diesen Prompt

Dieser Fortgeschritten-Prompt aus der Kategorie Code hilft dir bei: Vollständige API-Dokumentation mit Endpunkten, Parametern und Beispielen. Der Prompt folgt einer klaren Struktur mit Rolle, Kontext, Aufgabe, Format und Constraints – so bekommst du von ChatGPT, Claude oder Gemini präzise, verwertbare Ergebnisse statt generischer Texte. Relevante Themen: api, dokumentation, rest, openapi, swagger.

Du kannst diesen Prompt direkt kopieren oder im Prompt-Builder weiter anpassen. Ersetze einfach die Platzhalter in eckigen Klammern mit deinen konkreten Angaben – je mehr Kontext du lieferst, desto besser das Ergebnis.

So verwendest du diesen Prompt

  1. Prompt kopieren

    Klicke auf „Prompt kopieren" oben rechts.

  2. Platzhalter ersetzen

    Ersetze alle Angaben in [ECKIGEN KLAMMERN] mit deinen konkreten Informationen. Je mehr Kontext du gibst, desto besser das Ergebnis.

  3. In KI-Modell einfügen

    Füge den Prompt in ChatGPT, Claude oder Gemini ein.

  4. Ergebnis verfeinern

    Nicht zufrieden? Nutze den Prompt-Builder um den Prompt weiter anzupassen.