apiFunctionハンドラーがこの例外を引き起こすと、サーバーはhwebserver.errorResponseを使用して、指定されたエラーメッセージがerrorキーに含まれたJSONオブジェクトボディで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エンコード可能オブジェクトを“メッセージ”として指定することができます。
クライアントがJSONの受け入れを示した場合、そのレスポンスはJSONになり、そのボディはエラーメッセージがerrorキーに含まれたJSONオブジェクトになります。
エラーメッセージ文字列またはJSONエンコード可能オブジェクトをメッセージとして指定することができます。
クライアントがJSONの受け入れを示した場合、そのレスポンスはJSONになり、そのボディはエラーメッセージがerrorキーに含まれたJSONオブジェクトになります。