API-Beschreibung aus bestehenden Routen entwerfen

Vorlage, die aus bestehenden Routen und Beispielen einen OpenAPI-Entwurf mit Liste offener Punkte macht. Kopiere ihn in ein KI-Tool deiner Wahl, das dann den Entwurf der API-Beschreibung schreibt.

Thema: Apps & Prototypen
Art: Vorlage
Niveau: Fortgeschritten
Zeit: ca. 15 Min.

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

Ergebnis-Vorschau

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

paths: /orders/{id}: get: summary: Eine Bestellung abrufen responses: "200": { $ref: "#/components/schemas/Order" } "404": { description: Bestellung nicht gefunden } Offene Punkte: - status: hier „open“, in /orders „pending“ - Fehlerformat von /refunds unbekannt

Ausfüllen

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

APIWelche API?

MaterialWas kannst du einfügen?

ZweckWofür ist die Beschreibung?

Dein Prompt

Schreib einen OpenAPI-Entwurf für die folgende API.
API: [API]
Material: [Material]
Zweck: [Zweck]
Vorgehen: 1. Lies Routen, Methoden, Parameter und Beispielantworten aus dem Material. 2. Schreib je Route einen Eintrag mit kurzer Zusammenfassung, Parametern, Anfragekörper und Antworten, auch Fehlerantworten. 3. Beschreib wiederverwendbare Datenstrukturen einmal als Komponenten, statt sie zu wiederholen. 4. Beschreib die Anmeldung nur so weit, wie das Material sie zeigt, ohne etwas zu erfinden. 5. Liste offene Punkte auf: Felder mit unklarer Bedeutung, Routen, die sich anders verhalten als ähnliche Routen, und fehlende Fehlerbeschreibungen. 6. Markier jede Annahme im Entwurf als Kommentar.
Ausgabe: OpenAPI-Entwurf in YAML, Liste offener Punkte und Annahmen.

Achte besonders darauf, nur zu beschreiben, was das Material zeigt, und jede Annahme 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.

Schreib einen OpenAPI-Entwurf für die folgende API.
API: [API]
Material: [Material]
Zweck: [Zweck]
Vorgehen: 1. Lies Routen, Methoden, Parameter und Beispielantworten aus dem Material. 2. Schreib je Route einen Eintrag mit kurzer Zusammenfassung, Parametern, Anfragekörper und Antworten, auch Fehlerantworten. 3. Beschreib wiederverwendbare Datenstrukturen einmal als Komponenten, statt sie zu wiederholen. 4. Beschreib die Anmeldung nur so weit, wie das Material sie zeigt, ohne etwas zu erfinden. 5. Liste offene Punkte auf: Felder mit unklarer Bedeutung, Routen, die sich anders verhalten als ähnliche Routen, und fehlende Fehlerbeschreibungen. 6. Markier jede Annahme im Entwurf als Kommentar.
Ausgabe: OpenAPI-Entwurf in YAML, Liste offener Punkte und Annahmen.

Achte besonders darauf, nur zu beschreiben, was das Material zeigt, und jede Annahme 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.
Füg Beispiele mit erfundenen Werten ein; echte Tokens und Kundendaten gehören nicht ins Material.

Warum funktioniert das?

Eine aus dem Code geschriebene Beschreibung zeigt die Lücken, die niemand bemerkt, solange der Code läuft: undokumentierte Fehler, Felder mit zwei Bedeutungen und Routen, die aus dem Muster fallen.

Tipps

Gleich den Entwurf vor der Veröffentlichung mit der laufenden API ab; eine Beschreibung, die von der Wirklichkeit abweicht, ist schlechter als keine.

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-Beschreibung aus bestehenden Routen entwerfen

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

API-Referenz schreiben, mit der man sofort arbeiten kann Neu

Daten-Backfill gedrosselt planen Neu