Download the PHP package snappmarket/api-responder without Composer
On this page you can find all versions of the php package snappmarket/api-responder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download snappmarket/api-responder
More information about snappmarket/api-responder
Files in snappmarket/api-responder
Package api-responder
Short Description API Responder in SnappMarket's Way
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-responder
API Responder
This package provides some tools to generate API responses based on the White House Standards and some customization for SnappMarket team in Laravel.
:bulb: To start over, please read this document.
Installation
Usage
The bellow aliases are being registered in the main service provider of this package.
ApiResponderResponseforSnappMarket\ApiResponder\Facades\ResponseApiResponderErrorsforSnappMarket\ApiResponder\Facades\ErrorsRepository
In all the examples below, the aliases are being used instead of the full namespaces.
Registering Errors
Based on the White House Standards, every error code should points to an error entity. In the API Responder, you can register your errors and their information in an ErrorsRepository class to use them after that.
Unregistering Errors
It is a common problem that you need to unregister an error after registering it. You can do that with the code below.
Making Failure Responses
Given that in the White House Standards failure responses should return 400 or 500 responses. So that we have two usable methods to return errors with these statuses.
-
clientError(): This method is ready to generate the response body for the client errors. serverError(): This method is ready to generate the response body for the server errors.
After that, we also have another method to be used when you want to specify the status manually.
in SnappMarket, we add an object to the response JSON with name errors. This field can contain the detailed errors.
Replacements
You can place some replaceable phrases in the errors info while registering it, to make their contents dynamic. The replaceable phrases should start with a :.
The returning value will be:
Omitting Error Exception
By default, the errors repository throws exceptions on registering a previously registered error code and requesting for a non-existing error code. But you can disable throwing these exceptions with the code below.
Making Success Responses
As the White House Standards says, the success responses must contain two parts; results and metadata. We also add a meessages array to the metadata to contain messages. These parts can be passed to a success() method to generate a success response.
Key Formatter
You can register a closure to be used to format all the keys which are being generated by the package. For example, if we have a snake_case() function to map strings to the snake-case format, we can use the below code.
The returning result of this code will be:
:bulb: Changing the keys may take your responses out of the WhiteHouse Standards.
