Cómo devolver mensajes de error personalizados en Django Graphene

Creando mensajes de error personalizados en Django Graphene

Django Graphene es una herramienta poderosa para la creación de APIs de GraphQL en Django. Uno de los aspectos importantes de cualquier API es la gestión de errores, y Django Graphene te permite crear mensajes de error personalizados para mejorar la experiencia del usuario. En este artículo, aprenderás cómo crear tus propios tipos de errores y asignar mensajes de error a ellos.

Creando un tipo de error personalizado

Para comenzar, debes crear un nuevo tipo de error personalizado. Para ello, crea una clase que herede de graphene.Error:

from graphene import Error



class MiError(Error):

    pass

Ahora, puedes asignar un mensaje de error a tu tipo de error personalizado:

class MiError(Error):

    message = "Este es un mensaje de error personalizado."

Asignando el mensaje de error a un campo

Ahora que tienes tu tipo de error personalizado, puedes asignarlo a un campo en tu esquema de tipo. Por ejemplo:

from graphene import ObjectType, String, Field

from mi_app.errors import MiError



class Query(ObjectType):

    mi_campo = Field(String, resolver=mi_resolver)



def mi_resolver(root, info):

    raise MiError("Este es un mensaje de error personalizado.")

En este ejemplo, el campo mi_campo tendrá un mensaje de error personalizado cuando se produzca un error.

Mostrando el mensaje de error personalizado

Por último, debes mostrar el mensaje de error personalizado en tu respuesta. Para ello, debes crear un tipo de error personalizado en tu esquema de tipo y asignarle el mensaje de error:

from graphene import ObjectType, String, Error



class MiError(Error):

    message = "Este es un mensaje de error personalizado."



class Query(ObjectType):

    mi_campo = Field(String, resolver=mi_resolver)



def mi_resolver(root, info):

    raise MiError("Este es un mensaje de error personalizado.")

Ahora, cuando se produzca un error en el campo mi_campo, la respuesta tendrá un campo errors con un objeto MiError que contiene el mensaje de error personalizado:

{

  "data": {

    "mi_campo": null

  },

  "errors": [

    {

      "message": "Este es un mensaje de error personalizado.",

      "extensions": {

        "code": "MI_ERROR"

      }

    }

  ]

}

En resumen, creando tus propios tipos de errores y asignando mensajes de error a ellos te permite mejorar la experiencia del usuario en tu API de GraphQL con Django Graphene.

Si quieres conocer otros artículos parecidos a Cómo devolver mensajes de error personalizados en Django Graphene puedes visitar la categoría Python.