[VB.NET] REST API⑦ GETリクエストでエラー応答をする

2021年8月26日2021年10月7日

コントローラーのGETメソッドを変更し、リクエストに対して意図的にエラーを発生させてみましょう。
※ VisualStudio2019
APIプロジェクトの作成方法についてはこちらを参照してください。
このサンプルでは、以前作成した「ApiTestController」というコントローラーを使用しています。
コントローラーの追加方法はこちらを参照してください。

エラー応答の実装

コントローラーのGETメソッドで、特定の条件の時にエラーが発生するようにしてみましょう。

デフォルトのGETメソッド「GetValue」は以下のようになっています。

    ' GET api/ApiTest/5
    Public Function GetValue(ByVal id As Integer) As String
        Return "value"
    End Function

コードを以下のように書き換えて、ブラウザから実行してみましょう。

IDが５ならレコード（Dictionary）を返し、IDが５以外の時はエラーを発生させます。

この例では、「No record」というエラーメッセージを出力します。

        ' GET: api/ApiTest/5
        Public Function GetValue(ByVal id As Integer) As Dictionary(Of String, String)

            Dim rec As New Dictionary(Of String, String)

            'IDが 5 以外の場合、エラーとする
            If (id <> 5) Then
                Dim err_response As New System.Net.Http.HttpResponseMessage(HttpStatusCode.Forbidden)   '403
                err_response.Content = New System.Net.Http.StringContent("No record")
                Throw New HttpResponseException(err_response)
            End If

            'レコードを返す
            rec.Add("col1", id)
            rec.Add("col2", "This is a test record.")
            rec.Add("col3", New Date(2021, 1, 1))

            'レコードをリターン
            Return rec

        End Function