Den tatsächlichen API-Vertrag mit OpenAPI dokumentieren.
Eine API-Spezifikation sollte den tatsächlichen Vertrag mit Fehlern und Authentifizierung abbilden. Markiere unbekanntes Verhalten, statt eine ausgefeilte Endpunktbeschreibung zu erfinden.
Passe den Ablauf an deine Aufgabe an.
Dokumentiere tatsächlichen Endpunkt, Parameter, Authentifizierung und Antwortvertrag mit einer festgelegten OpenAPI-Version. Nenne bekannte Fehler und markiere Unbekanntes, statt aus Annahmen einen vollständig wirkenden Vertrag zu erstellen.
- Was du bereitstellst
- Überprüfte Endpunktbeschreibungen und Beispielantworten.
- Was du erhältst
- OpenAPI-Entwurf mit markierten ungeklärten Verträgen.
Sieh dir Eingabe und Ergebnis an.
Beispielhafte Ein- und Ausgabe · ein Lehrbeispiel, kein tatsächlicher WebAct-Durchlauf
Beispiel Eingabe
Produce an OpenAPI 3.1.1 JSON fragment for fictional GET /items. Confirmed response: status 200, application/json array, each item requires string id and name. Authentication and errors are not specified.
Vollständiges Beispiel
{
"openapi": "3.1.1",
"info": {"title": "Illustrative Items API", "version": "0.1.0"},
"paths": {
"/items": {
"get": {
"description": "Draft: authentication and error responses remain unspecified.",
"responses": {
"200": {
"description": "Items",
"content": {"application/json": {"schema": {
"type": "array",
"items": {"type": "object", "required": ["id", "name"], "properties": {
"id": {"type": "string"}, "name": {"type": "string"}
}}
}}}
}
}
}
}
}
}Lade diese Eingabe in den Prompt und kopiere ihn zum Ausprobieren nach WebAct. Dein Ergebnis kann vom Beispiel abweichen.
Entscheidungen und Fehlerbehebung.
Sollte ein OpenAPI-Entwurf Authentifizierung für einen undokumentierten Endpunkt erfinden?
Halte die Lücke fest und fordere die tatsächliche Anforderung an. Ein generiertes Sicherheitsschema darf nicht mit implementiertem Schutz verwechselt werden.
Warum scheitern generierte Clients trotz gültiger Spezifikation?
Vergleiche Schemas und Statusverhalten mit der tatsächlichen API. Strukturelle Gültigkeit belegt keine Übereinstimmung des dokumentierten Vertrags mit der Implementierung.
Quelle für diesen Arbeitsablauf.
Probiere es mit deiner eigenen Quelle.
Ersetze das Beispiel im Aufgaben-Prompt durch dein Material. Behalte nötige Anforderungen bei und kopiere die Aufgabe nach WebAct.
Aufgabe anpassen und kopieren ↑