Download the PHP package sinclairt/api-foundation without Composer
On this page you can find all versions of the php package sinclairt/api-foundation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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-foundation
API Foundation
A simple trait to build RESTful controllers using Fractal.
Installation
Register the service provider in config/app.php providers array:
Usage
Use the \Sinclair\ApiFoundation\Traits\ApiFoundation trait inside your API controllers to create RESTful controllers.
This is written as a trait to prevent inheritance issues, so feel free to overwrite any of the methods.
ApiFoundation ships with a default transformer, which turns the Eloquent model to an array, and with an overload __call method to handle includes for additional relationships.
You will need to __construct the controller to inject a resource implementation of Sinclair\Repository\Contracts\Repository and the transformer you would like to use. You can optionally set the resource name for Fractal to use.
There are fluent setters for the transformer, resource name, and repository should you need them.
Available Methods
- index GET paginated collection
- filter POST paginated collection
- store POST item
- show GET item
- update PUT/PATCH item
- destroy DELETE item
- restore GET item
Using Laravel/Eloquent to take the load off!
It is recommended to use the properties that Eloquent provides to reduce the code in the Transformers.
- Use the
$hidden/$visibleproperties to control what is seen inside an array. - Use the
$castsproperty to control the type the fields are cast to for arrays. See here for more detail. - Use the
$withproperty to control which relations are eager loaded by default.
It would be sensible to add the token auth driver to the api middleware group in App\Http\Kernel.php:
But you are free to use your own authorisation driver.
I strongly recommend setting up an API route group such as:
Use form requests for each resource so you're validation is abstracted away from the controller as well. I'd expect you to over write the store and update methods, so you can inject your form requests.
Finally, let's use Route Model Binding, here's a quick script I use for this in App\Providers\RouteServiceProvider:
