Fejlhåndtering
Som standard returnerer slutpunkter en 200 OK-meddelelse, selv om der er fejl. Hvis der opstår en fejl, får De et tomt svar fra slutpunktet. Dette dokument viser forskellige måder at håndtere fejl på i API'er.
Automatisk returnering af fejl
Hvis De automatisk vil returnere fejl fra API'er, kan De ændre standardfunktionsmåden ved at angive parameteren -ErrorAction for New-PSUEndpoint til Stop. Eventuelle fejl medfører, at der returneres en 500 Internal Server Error med en liste over fejlene og staksporingen.
Afsluttende fejl returnerer altid en 500 Internal Server Error.
New-PSUEndpoint -Url "/error" -Endpoint {
throw "Uh oh!"
} -ErrorAction stop
New-PSUEndpoint -Url /error2 -Endpoint {
Write-Error "Whoa!"
} -ErrorAction StopDe vil bemærke forskellig funktionsmåde i Windows PowerShell og PowerShell 7, når De kalder REST API'er, der returnerer fejl. I Windows PowerShell modtager De en generisk fejl, der ikke returnerer fejlmeddelelsen.
PS C:\Users\adamr> invoke-restmethod http://localhost:5000/error2
invoke-restmethod : The remote server returned an error: (500) Internal Server Error.
At line:1 char:1
+ invoke-restmethod http://localhost:5000/error2
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-RestMethod], Web
Exception
+ FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeRestMethodCommandI PowerShell 7, når der returneres en fejl, vil De se den returnerede fejlmeddelelse.
De kan hente fejlmeddelelsen i Windows PowerShell ved at bruge følgende syntaks.
Manuel returnering af fejl
For at returnere fejl manuelt skal De bruge cmdletten New-PSUApiResponse. Denne cmdlet giver Dem mulighed for at definere statuskoden og brødteksten for svaret.
I dette eksempel returnerer vi en 404-fejlkode fra slutpunktet.
I lighed med de automatiske fejlkoder vises manuelt returnerede fejlkoder også bedre i PowerShell 7. Her er et eksempel på kald af slutpunktet.
Hvis den kaldes fra Windows PowerShell, modtager De en fejl, der ligner den, der returneres automatisk.
De kan vælge at returnere fejlkoder, hvis bestemte betingelser er opfyldt, ved at bruge Deres PowerShell-script i slutpunktet.
API
Sidst opdateret
Var dette nyttigt?