Het echte API-contract documenteren met OpenAPI.
Een API-specificatie moet het echte contract weerspiegelen, inclusief fouten en authenticatie. Markeer onbekend gedrag in plaats van een gepolijste endpointbeschrijving te verzinnen.
Stem de werkwijze af op je taak.
Documenteer het echte endpoint, parameters, authenticatie en responscontract met een opgegeven OpenAPI-versie. Neem bekende fouten op en markeer onbekend gedrag in plaats van een volledig lijkend contract uit aannames te maken.
- Wat je aanlevert
- Geverifieerde endpointbeschrijvingen en voorbeeldresponsen.
- Wat je krijgt
- OpenAPI-concept met gemarkeerde onopgeloste contracten.
Bekijk de invoer en het resultaat.
Illustratieve invoer en uitvoer · een leervoorbeeld, geen live uitvoering van WebAct
Voorbeeld invoerveld
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.
Uitgewerkt voorbeeld
{
"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"}
}}
}}}
}
}
}
}
}
}Laad deze invoer in de prompt en kopieer deze naar WebAct om de taak te proberen. Je resultaat kan afwijken van het voorbeeld.
Keuzes en probleemoplossing.
Moet een OpenAPI-concept authenticatie voor een ongedocumenteerd endpoint verzinnen?
Noteer de leemte en vraag de echte eis op. Een gegenereerd beveiligingsschema mag niet voor geïmplementeerde bescherming worden aangezien.
Waarom falen gegenereerde clients ondanks een geldig specificatiedocument?
Vergelijk schema’s en statusgedrag met de echte API. Structurele geldigheid bewijst niet dat het beschreven contract bij de implementatie past.
Bron voor deze werkwijze.
Probeer het met je eigen bron.
Vervang het voorbeeld door je eigen materiaal in de taakprompt. Behoud de eisen die je nodig hebt en kopieer de taak naar WebAct.
De taak aanpassen en kopiëren ↑