API-Referenz schreiben, mit der man sofort arbeiten kann

Prompt, der aus Code und Beispielen eine Referenz je Endpunkt mit Fehlercodes und laufenden Aufrufen schreibt. Kopiere ihn in ein KI-Tool deiner Wahl, das dann die API-Referenz schreibt.

Thema: Apps & Prototypen
Art: Prompt
Niveau: Fortgeschritten
Zeit: ca. 10 Min.

Ergebnisse hängen vom Tool, vom Modell und von deinen Angaben ab.

Ergebnis-Vorschau

Beispiel: von unserer Redaktion geschrieben, keine echte KI-Ausgabe.

Ausfüllen

Deine Eingaben bleiben in diesem Browserfenster. Wir speichern und übertragen nichts.

SchnittstelleUm welche Schnittstelle geht es?

MaterialWas liegt vor?

LeserschaftWer liest die Referenz?

Dein Prompt

Schreibe eine Referenz für die folgende Schnittstelle.
Schnittstelle: [Schnittstelle]
Material: [Material]
Leserschaft: [Leserschaft]
Vorgehen: 1. Liste alle Endpunkte mit Methode, Pfad und einem Satz zum Zweck. 2. Beschreibe je Endpunkt Pfad-, Abfrage- und Body-Parameter mit Typ, Pflichtfeld, Standardwert und erlaubten Werten. 3. Zeige je Endpunkt einen vollständigen Beispielaufruf und eine Beispielantwort mit Platzhaltern statt echter Daten. 4. Nenne alle Fehlercodes mit Ursache und dem, was Aufrufende tun sollen. 5. Erkläre Anmeldung, Grenzen pro Zeit, Seitenweise Abfrage und Versionierung an einer Stelle. 6. Markiere alles, was du aus dem Material nicht sicher ableiten kannst, als offene Frage.
Ausgabe: Referenz in Markdown, ein Abschnitt je Endpunkt, am Ende die Liste offener Fragen.

Achte besonders darauf, nur zu dokumentieren, was das Material belegt, und Unklares als offene Frage zu markieren.

Prüfe vor deiner Antwort: Sind alle Vorgaben erfüllt? Fehlt eine wichtige Angabe oder steht noch ein Platzhalter in eckigen Klammern im Text, frag nach, statt zu raten. Kennzeichne Annahmen als solche.

Schreibe eine Referenz für die folgende Schnittstelle.
Schnittstelle: [Schnittstelle]
Material: [Material]
Leserschaft: [Leserschaft]
Vorgehen: 1. Liste alle Endpunkte mit Methode, Pfad und einem Satz zum Zweck. 2. Beschreibe je Endpunkt Pfad-, Abfrage- und Body-Parameter mit Typ, Pflichtfeld, Standardwert und erlaubten Werten. 3. Zeige je Endpunkt einen vollständigen Beispielaufruf und eine Beispielantwort mit Platzhaltern statt echter Daten. 4. Nenne alle Fehlercodes mit Ursache und dem, was Aufrufende tun sollen. 5. Erkläre Anmeldung, Grenzen pro Zeit, Seitenweise Abfrage und Versionierung an einer Stelle. 6. Markiere alles, was du aus dem Material nicht sicher ableiten kannst, als offene Frage.
Ausgabe: Referenz in Markdown, ein Abschnitt je Endpunkt, am Ende die Liste offener Fragen.

Achte besonders darauf, nur zu dokumentieren, was das Material belegt, und Unklares als offene Frage zu markieren.

Prüfe vor deiner Antwort: Sind alle Vorgaben erfüllt? Fehlt eine wichtige Angabe oder steht noch ein Platzhalter in eckigen Klammern im Text, frag nach, statt zu raten. Kennzeichne Annahmen als solche.

Das ist eine Anleitung für eine KI, noch nicht das Ergebnis.

Damit funktioniert der Prompt

Diese KI-Tools eignen sich für diesen Prompt:

So gehst du vor

Fülle die Felder aus oder tippe auf einen Vorschlag. Lass Namen, Adressen und andere persönliche Daten weg.
Kopiere den fertigen Prompt in ein KI-Tool deiner Wahl.
Gib einer Person, die die Schnittstelle nicht kennt, nur die Referenz. Schafft sie den ersten erfolgreichen Aufruf ohne Rückfrage, ist die Referenz gut.

Warum funktioniert das?

Referenzen scheitern selten an fehlenden Endpunkten, sondern an fehlenden Fehlercodes, unklaren Pflichtfeldern und Beispielen, die nicht laufen. Ein fester Aufbau je Endpunkt und offene Fragen statt geratener Antworten machen sie verlässlich.

Tipps

Ersetze Schlüssel, Tokens und Kundendaten in Beispielen durch Platzhalter, bevor du Material ins KI-Tool gibst.

Du darfst unsere Prompts frei nutzen, auch beruflich. Bitte veröffentliche sie nicht als eigene Sammlung. Für KI-Ergebnisse übernehmen wir keine Gewähr; prüfe sie selbst. Nutzungsbedingungen

API-Referenz schreiben, mit der man sofort arbeiten kann

Ergebnis-Vorschau

Ausfüllen

Dein Prompt

Damit funktioniert der Prompt

So gehst du vor

Warum funktioniert das?

Tipps

Passt auch zu

Paginierung für eine API-Liste festlegen Neu

Daten-Backfill gedrosselt planen Neu

Caching für einen langsamen Endpunkt planen Neu