apiFunction
ハンドラーがこの例外を引き起こすと、サーバーはhou.webServer.errorResponse()を使用して、エラーメッセージが設定されたerror
キーを含んだJSON Objectボディと共に422 Unprocessable Entity
レスポンスを生成します。
ハンドラー関数で他の種類の例外が発生すると、一般的な500 Internal Server Error
が生成されます。
サーバーがデバッグモードで起動されていれば、そのレスポンスボディにはスタックトレースが含まれます。
Note
webapiclient.py
にもAPIError
例外クラスが含まれています。
API関数がサーバーからAPIError
例外を引き起こした場合、webapiclient
もクライアントからAPIError
を引き起こします。
サーバー上のAPI関数が他の例外を引き起こして500を返した場合、webapiclient
も500レスポンスの内容と共にAPIerror
を引き起こします。
クライアントからapi_error.status_code
にアクセスすることで、422エラーと500エラーを区別することができます。
メソッド ¶
__init__(msg)
エラーメッセージの文字列またはJSONエンコード可能なオブジェクトを“msg”引数に指定することができます。
クライアントがその引数にJSONが指定されたと認識すると、そのレスポンスはJSONになり、そのボディはエラーメッセージが設定されたerror
キーを含んだJSONオブジェクトです。