Download the PHP package igsem/api-exceptions without Composer
On this page you can find all versions of the php package igsem/api-exceptions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download igsem/api-exceptions
More information about igsem/api-exceptions
Files in igsem/api-exceptions
Package api-exceptions
Short Description Handle exceptions in Phalcon or other PHP APIs in a consistent way. Return consistent responses with proper response codes and have your errors and exceptions be logged into file on production.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api-exceptions
Response generation, Exception handling and Logging for API's
Use with Phalcon, Lumen and any other PHP app suporting php 7+
Your code:
Your response:
Automatically catches all your errors and exceptions and returns a nice API friendly message. It provides a list of exceptions to use in your API, these resolve to standard HTTP STATUS CODES with a default message.
All exceptions which do not implement Igsem\ApiExceptions\Exceptions\ApiExceptionInterface return a 500 status code and log the message into a custom log file.
You can register your own exception, the only requirement is to implement ApiExceptionInterface.
You can customize every message and code plus send additional debug info for development env.
What it does
- returns API friendly responses
- provides an API for creating custom responses
- logs all unexpected errors and exceptions
- can send emails if unexpected exception or error occurs
- provides additional debug info in development
- hides all unexpected errors and exceptions in production
- handles almost all non 200 responses which may occur in an API
Installation
In your front controller or when bootstrapping your application just register the handler:
The environment by default is set to production and no mailer is required. The library supports only swiftmailer.
The Logger is a little tricky one. As everyone implements their own logger usually and most of the time they are not PSR 3 compatible, therefore we decided to require our custom interface. You can pass in any Loger until it implements
We are providing a Logger class for Phalcon by default.
This is an example of our logger creation:
It only requires a path to the log folder. There are only 3 methods available:
- logError
- logException
- logMessage
The logger will create separate files with debug info, proper formats and info required for debugging.
You can still use your logger and just extend it with logError and logException just to let the library know how to handle these cases.
!If you decide to use the library, please remove the try catch block around your application. The library registers its own error and exception handlers.
Custom exception example
In the same way, you can create your own custom exceptions. If they implement ApiExceptionInterface, they will be caught and the correct response will be returned.
List of available exceptions
- AccessDeniedException
- BadRequestException
- InvalidCredentialException
- InvalidParametersException
- NotFoundException
- TokenException
- UnAuthorizedException
