Download the PHP package treblle/api-responses without Composer
On this page you can find all versions of the php package treblle/api-responses. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download treblle/api-responses
More information about treblle/api-responses
Files in treblle/api-responses
Package api-responses
Short Description A package to help you keep your API Responses standardized.
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-responses
A package to help you keep your API Responses standardized.
Installation
Usage
This package is easy to use, it is designed to be used within your controllers to return API responses that are simple and standardized.
Using the configuration
You can publish the configuration for this package using the following artisan command:
This will return the configuration file for this package. Currently, the configuration only covers headers used in responses.
The HeaderFactory that is used in the response classes will pull with HeaderFactory::default() or HeaderFactory::error() depending if you are returning an error or a response.
You can override the available headers using the configuration file. This is executed outside of any middleware you may be using - which will merge in relevant Headers as required, such as Rate Limiting and Cache headers you may have set.
Returning a single model
Some API endpoints just need to return a single model, in this situation you should use the ModelResponse which accepts a JsonResource representation of your model.
Returning a collection of models
Other API endpoints want to return a collection of models, in these situations you should use the CollectionResponse which accepts an AnonymousResourceCollection which is a collection of Models transformed through API Resources.
When something goes wrong
The best approach when something goes wrong in your API, the best approach is to allow this to bubble up the your Exception Handler and manage how you respond in one central place.
Sending a simple message response
Sometimes all you need to do is send a simple message back through your API. Perhaps you are pushing the logic to a background job.
Sending back a more complex message response
At times you want to pass back a message as well as some data, perhaps to signify actions that need to be taken.
General Usage
This package currently contains the following responses:
ModelResponse: For responding a single model resource.CollectionResponse: For responding a collection of models for a resource.ErrorResponse: For responding when you have encountered an Error.MessageResponse: For when you are returning a simple message.ExpandedResponse: For when you want to send a message and some data in the response.
Please note, the ErrorResponse is not idea for any 400 responses as these are user errors such as wrong resource or Validation problems.
Community 💙
First and foremost: Star and watch this repository to stay up-to-date.
Also, follow our Blog, and on Twitter.
You can chat with the team and other members on Discord and follow our tutorials and other video material at YouTube.
How to contribute
Here are some ways of contributing to making Treblle better:
- Try out Treblle, and let us know ways to make Treblle better for you. Let us know here on Discord.
- Join our Discord and connect with other members to share and learn from.
- Send a pull request to any of our open source repositories on Github. Check the contribution guide on the repo you want to contribute to for more details about how to contribute. We're looking forward to your contribution!
-
Testing
To run the test suite:
Credits
LICENSE
The MIT LIcense (MIT). Please see License File for more information.
