Zum Inhalt springen
Claude Opus 4.54.8 · 5,600 Aufrufe

API-Dokumentationsgenerator

Erzeuge klare, strukturierte API-Dokumentation aus Code oder Endpunkt-Beschreibungen.

Der Prompt

Erstelle API-Dokumentation für die folgenden Endpunkte.

Endpunkt: [URL und Methode]
Authentifizierung: [Typ]
Request-Body: [Schema oder Beispiel]
Response: [Schema oder Beispiel]

Enthalten:
1. Kurzbeschreibung
2. Request-Parameter (Path, Query, Body)
3. Response-Format mit Statuscodes
4. Ein Request/Response-Beispiel
5. Fehlercodes und Hinweise zur Behandlung

Formatiere als Markdown, geeignet für OpenAPI/Swagger-Integration.

So verwenden Sie diesen Prompt

Kopieren Sie den Prompt, ersetzen Sie die [Platzhalter in eckigen Klammern] durch Ihren eigenen Kontext und fügen Sie ihn in Ihr KI-Tool ein. Ton und Umfang lassen sich nach Bedarf anpassen.

Modell
Claude Opus 4.5
Bewertung
4.8 / 5
API-DocsDokumentationEntwickler

Verwandte Prompts