restyphp/slim-json-handler-error

Redefine Slim errors to JSON. Implements JSON-API Errors (v1.0)

Deprecated, _(*1)

Slim Json Error Handler

, _(*2)

Redefine el formato de los mensajes de Slim a JSON. Implementa [JSON-API Errors](JSON-API Errors) (v1.0)., _(*3)

Versión estable

0.4.1, _(*4)

License

The MIT License (MIT). Ver el archivo LICENSE para más información, _(*5)

Introducción

Slim posee cuantro handlers para manejar distintos tipos de error, _(*6)

• Errores de PHP (PhpError)
• Ruta no encontrada (NotFound)
• Método HTTP incorrecto (NotAllowed)
• Captura de excepciones de usuario (Error)

Cada uno de ellos devuelve el error en el formato que sea solicitado por a cabecera Content-type (hmtl, json, etc). Este middleware reescribe estos handlers para que siempre devuelvan formato JSON., _(*7)

Formato de respuesta, _(*8)

Para unificar el formato de respuesta se siguió el estandar de JSON-API Error, _(*9)

Ejemplo

{
  "errors": [
    {
      "title": "Internal server error",
      "details": "...",
      "code": XXX,
      "status": 500
    }
  ]
}

Donde:, _(*10)

Configuración de Slim

// Slim
use Slim\App;
use Resty\Slim\BuilderJsonErrorResponses;

$config = [
    // ....
];

// para Desarrollo / QA
$config['settings'] = [
    "displayErrorDetails" => true
];

// para Producción
$config['settings'] = [
    "displayErrorDetails" => false
];

// Redefine - errors
$config['errorHandler'] = BuilderJsonErrorResponses::jsonError();
$config['phpErrorHandler'] = BuilderJsonErrorResponses::jsonPhpError();
$config['notFoundHandler'] = BuilderJsonErrorResponses::jsonNotFound();
$config['notAllowedHandler'] = BuilderJsonErrorResponses::jsonNotAllowed();

$app = new App($config);
// ...

Mensajes de error

Errores de PHP

Clase: \Resty\Slim\Handler\Error, _(*11)

{
  "errors": [
    {
        "title": "Internal server error",
        "details": "...",
        "code": 0,
        "status": 500,
        "source": {
            "file": "...",
            "line": "..."
        },
        "meta": {
            "trace": [...]
        }
    }
  ]
}

Ruta no encontrada

Clase: \Resty\Slim\Handler\NotFound, _(*12)

{
  "errors": [
    {
      "title": "Page not found",
      "details": "Request => GET:http://www.dummy.com/dummies",
      "code": 0,
      "status": 404
    }
  ]
}

Método HTTP incorrecto

Clase: \Resty\Slim\Handler\NotAllowed, _(*13)

{
  "errors": [
    {
      "title": "Method not allowed",
      "details": "Request => POST:http://www.dummy.com. Method not allowed. Must be one of GET",
      "code": 0,
      "status": 405
    }
  ]
}

Captura de excepciones de usuario

Clase: \Resty\Slim\Handler\Error, _(*14)

{
  "errors": [
    {
        "title": "Internal server error",
        "details": "...",
        "code": 0,
        "status": 500,
        "source": {
            "file": "...",
            "line": "..."
        },
        "meta": {
            "trace": [...]
        }
    }
  ]
}