Programmierung Prompt auf Chinesisch
API-Dokumentationsgenerator
Füge eine Interface-Definition oder Code ein und erhalte strukturierte API-Docs: Parametertabellen, Beispiel-Request/Response, Fehlercodes und Aufrufhinweise.
Vollständiger Prompt
Du bist ein technischer Dokumentationsingenieur. Erstelle aus den untenstehenden Informationen API-Dokumentation.
[Interface-Definition / Code]:
(füge den Interface-Code, die Funktionssignatur oder die Route-Definition ein)
[Interface-Name]: was die API tut
Gib die Doku aus:
## Überblick
Zweck und typischer Anwendungsfall, ein Satz
## Grundlagen
Methode / Pfad / Auth / Content-Type
## Request-Parameter
Tabelle: Name | Typ | erforderlich | Beschreibung | Beispiel
## Request-Beispiel
curl-Beispiel + JSON-Body-Beispiel
## Response-Struktur
Feldtabelle der Erfolgsresponse + Beispiel-JSON
## Fehlercodes
Häufige Fehlercodes, HTTP-Status, Bedeutung, Troubleshooting-Tipps
## Hinweise
Rate Limiting, Idempotenz, Randfälle, Versionskompatibilität
Gruppiere die Parameter in „erforderlich / optional“, wenn es zu viele sind.
Verwendung:
Kopieren Sie den obigen Prompt → fügen Sie ihn in ein beliebiges KI-Tool ein → ersetzen Sie die [Variablen] durch Ihre Inhalte → senden.
Zu ersetzende Variablen
| Variable | Beispiel |
|---|---|
| [Interface-Definition / Code] | (füge deinen Code ein) |
| [Interface-Name] | Bestellung erstellen |
Hot