Dokumentation

Dokumentation¶

När vi kört ett test kan vi skapa en dokumentation av resultatet. Varje operation kan ha flera dokumentationer kopplat till sig.

Fyll i namn och en valfri beskrivning. Var gärna beskrivande med namnet.

Vi kan även skapa dokumentation för misslyckade operationer om vi forcerar fel i API:t.

Namn som "Lyckad körning", "Validering Misslyckades" eller "Användare finns redan" kan vara ett tips.

Skapa Dokumentation¶

Tryck på knappen för att skapa dokumentation och den ska sedan dyka upp i panelen.

Läsa dokumentationen¶

Svaret vi får tillbaka omtolkas och översätts till variabler. Vi kan för varje dokumentation se ett namn som även kommer kunna användas som en parser-tagg.

Vi får också tillbaka en uppskattad typ på värdet.

Till sist ser vi ett exempel på hur värdet är formaterat.

Observera att vi inte visar faktiska värden i dokumentation då den kan innehålla känsliga uppgifter.

Använda dokumentationen¶

I När-om-Så dyker det sedan en länk till dokumentationen som öppnar sig i nytt fönster.

Dokumentationslänk

Om du har skapat flera dokumentationer för en operation listas dem i samma fönster.

Dokumentationslänk