Gestione degli errori

Per impostazione predefinita, gli endpoint restituiscono un messaggio 200 OK anche in presenza di errori. Se si verifica un errore, riceverà una risposta vuota dall'endpoint. Questo documento illustra diversi modi per gestire gli errori all'interno delle API.

Restituzione automatica degli errori

Per restituire automaticamente gli errori dalle API, può modificare il comportamento predefinito impostando il parametro -ErrorAction di New-PSUEndpoint su Stop. Qualsiasi errore comporterà la restituzione di un 500 Internal Server Error con un elenco degli errori e lo stack trace.

Gli errori di tipo terminating restituiranno sempre un 500 Internal Server Error.

New-PSUEndpoint -Url "/error" -Endpoint { 
   throw "Uh oh!"
} -ErrorAction stop

New-PSUEndpoint -Url /error2 -Endpoint {
    Write-Error "Whoa!"
} -ErrorAction Stop

Noterà un comportamento diverso in Windows PowerShell e in PowerShell 7 quando chiama API REST che restituiscono errori. In Windows PowerShell riceverà un errore generico che non restituisce il messaggio di errore.

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.InvokeRestMethodCommand

In PowerShell 7, quando viene restituito un errore, vedrà il messaggio di errore restituito.

PS C:\Users\adamr\Desktop> invoke-restmethod http://localhost:5000/error 

Invoke-RestMethod: Uh oh!
at , : line 2
at , : line 1

PS C:\Users\adamr\Desktop> invoke-restmethod http://localhost:5000/error2

Invoke-RestMethod: Whoa
at , : line 2
at , : line 1

Può recuperare il messaggio di errore in Windows PowerShell utilizzando la sintassi seguente.

PS C:\Users\adamr> try { invoke-restmethod http://localhost:5000/error2 } catch { [System.IO.StreamReader]::new($_.Exception.Response.GetResponseStream()).ReadToEnd()}
Whoa!
at <ScriptBlock>, <No file>: line 2
at <ScriptBlock>, <No file>: line 1

Restituzione manuale degli errori

Per restituire manualmente gli errori, deve utilizzare il cmdlet New-PSUApiResponse. Questo cmdlet consente di definire il codice di stato e il corpo della risposta.

In questo esempio restituiamo un codice di errore 404 dall'endpoint.

New-PSUEndpoint -Url /broken -Endpoint {
    New-PSUApiResponse -StatusCode 404 -Body 'Failed!'
}

Analogamente ai codici di errore automatici, i codici di errore restituiti manualmente vengono visualizzati meglio in PowerShell 7. Ecco un esempio di chiamata all'endpoint.

PS C:\Users\adamr\Desktop> invoke-restmethod http://localhost:5000/broken

Invoke-RestMethod: Failed!

Se chiamato da Windows PowerShell, riceverà un errore simile a quello restituito automaticamente.

PS C:\Users\adamr> invoke-restmethod http://localhost:5000/broken
invoke-restmethod : The remote server returned an error: (404) Not Found.
At line:1 char:1
+ invoke-restmethod http://localhost:5000/broken
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-RestMethod], Web
   Exception
    + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeRestMethodCommand

Può scegliere di restituire codici di errore se sono soddisfatte determinate condizioni, utilizzando il suo script PowerShell all'interno dell'endpoint.

New-PSUEndpoint -Url /user/:name -Endpoint {
    if ($Name -eq 'User')
    {
        @{ UserName = "Adam" }
    }
    else
    {
        New-PSUApiResponse -StatusCode 404 -Body 'Unknown user!'    
    }

}

API

• New-PSUEndpoint
• Get-PSUEndpoint
• Remove-PSUEndpoint
• New-PSUApiResponse
• Set-PSUSetting