es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

API Kong – ¿Cómo establecer un mensaje de error personalizado?

No estoy muy familiarizado con Kong y sus características. Solo quiero preguntar si es posible modificar el mensaje de error en la siguiente situación.

La URL válida de la API para alguna solicitud es, por ejemplo,

example.com/api/somerequest

Si deseo realizar una solicitud a una URL no válida, por ejemplo,

example.com/api/adffgdsfgfa

Obtendré el siguiente mensaje de error:

“request_path”: “/api/adffgdsfgfa”,
“message”: “API no encontrada con estos valores”

Me gustaría reemplazar este mensaje predeterminado (API no encontrada…) con mi mensaje personalizado. ¿Alguien podría ayudarme a hacerlo?

Tags:  ,

Answer

  1. Avatar for davy.ai

    Sí, es posible modificar el mensaje de error en Kong. Puede lograr esto creando un complemento de controlador de error personalizado en Kong.

    Aquí están los pasos para crear un complemento de controlador de error personalizado:

    1. Cree un nuevo módulo Lua en Kong que se encargará del mensaje de error personalizado. Puede utilizar el siguiente fragmento de código como punto de partida:
    local BasePlugin = require "kong.plugins.base_plugin"
    
    local CustomErrorHandler = BasePlugin:extend()
    
    CustomErrorHandler.PRIORITY = 2
    
    function CustomErrorHandler:new()
      CustomErrorHandler.super.new(self, "custom-error-handler")
    end
    
    function CustomErrorHandler:access(conf)
      CustomErrorHandler.super.access(self)
    
      kong.response.set_header("Content-Type", "application/json")
      kong.response.exit(404, { message = "Su mensaje de error personalizado aquí" })
    end
    
    return CustomErrorHandler
    
    1. Agregue el complemento de controlador de error personalizado a su instancia de Kong creando una nueva API con el complemento habilitado. Puede hacer esto a través de la API de administración de Kong o el Tablero de Kong.
    2. Una vez que el complemento de controlador de error personalizado se agregue a su instancia de Kong, cualquier solicitud a URL de API no válidas activará el complemento y devolverá el mensaje de error personalizado.

    Tenga en cuenta que es posible que deba modificar el módulo Lua para adaptarlo a sus requisitos específicos. Además, se recomienda probar el complemento a fondo en un entorno de desarrollo o puesta en escena antes de implementarlo en producción.

Comments are closed.