Ein API-Dokumentations-Prompt löst das Aufschieben, das auf fertige Endpunkte folgt: Der Code läuft längst, aber Aufrufer müssen den Quellcode lesen, um Parameter zu erraten, und bei jeder Integration kommen dieselben Fragen zu Typen, Pflichtfeldern und Fehlercodes. Kopieren Sie den Prompt unten, fügen Sie den Endpunkt-Code oder die Definition ein, tragen Sie Zielgruppe und Ausgabeformat ein, und die KI liefert Zweck, Parametertabelle, Anfragebeispiel, Antwortbeispiel und Fehlercode-Hinweise in genau der Reihenfolge, in der Aufrufer sie nachschlagen. Felder prüfen, und die Doku kann raus.
Für welche Situation dieser Prompt gedacht ist
Er passt zu Endpunkten, die bereits Code haben und denen nur die Dokumentation fehlt: ein Backend-Endpunkt vor der Übergabe an Frontend-Entwickler oder einen externen Partner, ein Altprojekt, das Doku nachzieht, oder ein neuer Kollege, der vor der Übernahme Ein- und Ausgaben einer Reihe von Endpunkten kartiert. Fachregeln kann er nicht für Sie bestätigen. Validierungslogik, Berechtigungen und Grenzwerte, die der Code nicht nennt, dürfen nur als offene Fragen markiert werden, niemals erfunden. Ändern sich die Felder noch täglich, erzeugen Sie zuerst nur die Parametertabelle und ergänzen Sie Beispiele erst, wenn die Felder stabil sind, damit die Doku nicht in der Woche ihrer Erstellung veraltet.
Der Prompt, direkt zum Kopieren
Du bist Redakteur für API-Dokumentation. Schreibe auf Grundlage des Endpunkt-Codes oder der Definition, die ich einfüge, eine Dokumentation, gegen die ein Aufrufer direkt integrieren kann.
Endpunkt-Code oder Definition: {{Endpunkt_Code}}
Zielgruppe: {{Zielgruppe}}
Authentifizierung: {{Auth_Methode}}
Hinweise zur Basisadresse: {{Basisadresse}}
Anforderungen an die Ausgabe:
1. Beschreibe zuerst in zwei Sätzen, was dieser Endpunkt tut und wann er aufgerufen wird. Wiederhole den Code nicht.
2. Gib danach eine Parametertabelle aus. Nenne zu jedem Parameter Name, Position (Pfad, Query, Header oder Body), Typ, ob er Pflicht ist, und seine Bedeutung. Markiere jede Bedeutung, die der Code nicht zeigt, als zu bestätigen; rate nicht.
3. Gib ein vollständiges Anfragebeispiel und ein erfolgreiches Antwortbeispiel. Feldnamen und Typen müssen exakt zum Code passen, Beispielwerte müssen erkennbar fiktive, maskierte Daten sein.
4. Füge einen eigenen Abschnitt zu Fehlercodes hinzu. Liste nur Fehler auf, die der Code tatsächlich auslöst, mit Auslöser und dem, was der Aufrufer tun soll. Ergänze keine Fehlercodes, die nicht im Code stehen.
5. Schließe mit einer Liste offener Fragen: Validierungsregeln, Berechtigungen und Grenzfälle, die der Code offenlässt, Punkt für Punkt, damit ich sie bestätigen kann, bevor sie in den Haupttext wandern.So füllen Sie die Variablen aus
- Endpunkt-Code: Fügen Sie Handler, Routendefinition und die zugehörigen Anfrage- und Antworttypen ein, nicht nur einen Funktionsnamen. Je vollständiger der Kontext, desto weniger Zeilen mit „zu bestätigen“ enthält die Tabelle.
- Zielgruppe: Schreiben Sie, ob es interne Frontend-Entwickler, ein externer Partner oder ein neu gestarteter Backend-Entwickler sind. Die Zielgruppe entscheidet, wie ausführlich Beispiele sein müssen und ob Fachbegriffe erklärt werden.
- Authentifizierung: Nennen Sie Token, Signatur oder Gateway-Authentifizierung. Gibt es keine, schreiben Sie ausdrücklich „keine“, statt das Feld leer zu lassen und die KI einen Auth-Abschnitt erfinden zu lassen.
- Basisadresse: Beschreiben Sie nur Umgebungen, etwa getrennte Test- und Produktionsumgebung. Schreiben Sie niemals echte Schlüssel oder Zugangsdaten in den Prompt.
Diese drei Stellen im Entwurf prüfen
Erstens: Vergleichen Sie jedes Feld mit dem Code. Eine KI macht aus einem optionalen Parameter gelegentlich einen Pflichtparameter oder ergänzt in einem Beispiel ein Feld, das der Code nie zurückgibt; vergleichen Sie die Tabelle also Wort für Wort mit den Typen. Zweitens: Achten Sie auf zu großzügig ergänzte Fehlercodes. Jeder Code und Status, der im Quelltext nicht zu finden ist, gehört auf die Liste offener Fragen, nicht in den Fehlerabschnitt. Drittens: Maskieren Sie Beispielwerte sauber. Ersetzen Sie Telefonnummern, E-Mails und Bestellnummern durch erkennbar fiktive Werte, statt echte Integrationsdaten in der Doku zu lassen.
Muss eine ganze Reihe von Endpunkten dokumentiert werden, erzeugen Sie einen Endpunkt nach dem anderen, damit die Feldkonventionen einheitlich bleiben; zehn Endpunkte auf einmal lassen Parametertabellen ineinanderlaufen. Die Reihenfolge funktioniert bei der Integration auch umgekehrt: Meldet ein Aufrufer einen Parameterfehler, klären Sie zuerst mit dem Debugging-Prompt: Fehler und Code einfügen, Ursache in einem Durchlauf erhalten, ob die Doku oder der Aufruf falsch ist, und korrigieren Sie dann diese Seite.
