【Django-ninja】在django ninja中处理异常

babybin

已于 2024-02-05 00:02:32 修改

阅读量1.5k

点赞数 4

文章标签： django python 后端

于 2024-02-04 23:59:11 首次发布

本文链接：https://blog.csdn.net/babybin/article/details/136034527

版权

本文介绍了如何在DjangoNinja框架中使用内置异常类如HttpError和ValidationError，以及如何覆写异常处理函数和自定义异常类型，如ServiceUnavailableError，以实现更精确的HTTP状态码和错误消息返回。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1. 直接抛内置异常

Django ninja内置了一些常用异常类。

from ninja.errors import HttpError

@api.get("/some/resource")
def some_operation(request):
    if True:
        raise HttpError(503, "Service Unavailable. Please retry later.")

2. 覆写异常类

可以覆写内置异常类的handler，改变返回结果的内容。

from ninja.errors import ValidationError
...

@api.exception_handler(ValidationError)
def validation_errors(request, exc):
    return HttpResponse("Invalid input", status=422)

3. 自定义异常类

以创建一个500服务不可用异常类为例。

要实现这一点，你需要：

自定义一个ServiceUnavailableError
使用 api.exception_handler 为ServiceUnavailableError异常添加一个处理函数

api = NinjaAPI()

class ServiceUnavailableError(Exception):
    pass


# initializing handler

@api.exception_handler(ServiceUnavailableError)
def service_unavailable(request, exc):
    return api.create_response(
        request,
        {"message": "Please retry later"},
        status=503,
    )


# some logic that throws exception

@api.get("/service")
def some_operation(request):
    if random.choice([True, False]):
        raise ServiceUnavailableError()
    return {"message": "Hello"}