Mock-beteende
Mock-objekt ger oftast statiska svar på begäranden som motsvarar API-kontraktet. De svarar på begäranden utan hänsyn till någon säkerhet som definierats för API:et, begärans nyttolast eller begärandehuvuden (förutom huvudet Accept som används för innehållsförhandling).
När en begäran görs skapar mock-objektet ett svar antingen baserat på vad användaren angav (exempel, standardvärde, uppräkningsvärde) eller med hjälp av ett inbyggt exempelvärde.
Om begäran till exempel returnerar ett objekt används exemplet på objektet om ett sådant anges. Om inte, används exemplen på var och en av egenskaperna och ett JSON-objekt skapas utifrån det. Detta fungerar även för svarshuvuden.
Svar
- Om din åtgärd bara har ett svarsintervall returneras den första statusen i intervallet. Till exempel returnerar en åtgärd med ett svarsintervall på 2XX ett 200-svar.
- Om din åtgärd har en specifik svarskod och svarsintervall eller ett standardsvar returneras den definierade koden. Till exempel returnerar en åtgärd med ett 201-svar och ett svarsintervall på 3XX 201-svaret.
- Om din åtgärd har flera svarsintervall och ingen definierad svarsstatus returneras den första statusen i det första intervallet. Till exempel returnerar en åtgärd med ett svarsintervall på 4XX och 5XX ett 400-svar.
- Om din åtgärd bara har ett standardsvar beror svaret som returneras på åtgärdsmetoden:
- Om metoden som används är POST returneras ett 201-svar.
- För andra metoder returneras ett 204-svar om ingen svarskropp har definierats och ett 200-svar returneras om en svarskropp har definierats.
- Om din åtgärd inte har något definierat svar returneras ett 200-svar.
- 1XX-svar stöds inte av mock-objekt. Om en åtgärd har svarsintervallet 1XX eller en definierad svarskod i detta intervall returneras ett 404-svar.
Kombinationer
- Alla av: om ett exempel har definierats returneras det. Om inget exempel har definierats för datatypen slås egenskaperna för typerna samman och exemplen som definierats på egenskapsnivå används eller så genereras exempelvärden. Om en egenskap definieras två gånger i olika typer bevaras endast det sista värdet. Primitiva typer kasseras, endast objekt returneras.
- Någon av eller En av: om ett exempel har definierats returneras det. Om inget exempel har definierats genereras ett svar från den första typen i listan.
Begränsningar
- Endast tillgänglig i begäran: egenskapen är utesluten från det genererade exemplet.
- Endast tillgänglig i svar: egenskapen inkluderas i det genererade exemplet.
- Tillgänglig i begäran och svar: egenskapen inkluderas i det genererade exemplet.
Exempel som tillhandahålls på datatypsnivå har företräde framför egenskaper. Om en egenskap som definierats som Endast tillgänglig i begäran är inkluderad i exemplet returneras den i svaret. Om en egenskap som definierats som Endast tillgänglig i svar eller Tillgänglig i begäran och svar inte är inkluderad i exemplet returneras den inte i svaret.