Download the PHP package origami/api without Composer
On this page you can find all versions of the php package origami/api. 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
Origami API Package
This package simplifies the process of setting up an API using Laravel 6. Many of the practices utilised in this package are courtesy of Build APIs you Won't Hate by Phil Sturgeon.
Installation
Install this package through Composer.
composer require origami/api
Requirements
This package is designed to work with Laravel >= 6 currently.
Configuration
There are some API configuration options that you'll want to overwrite. First, publish the default configuration.
This will add a new configuration file to: config/api.php.
keys
This is the valid list of API keys that authenticate requests. By default we support an environment variable of API_KEY which you can set in your .env file.
Middleware
This package includes two Middleware classes for Laravel 6
Origami\Api\Middleware\AuthenticateApiKey
The AuthenticateApiKey Middleware is designed to guard Api routes against unauthorised access. We recommend you include it on all routes as follows, unless you have a public API.
Controllers
We provide a helpful ApiController base controller class that includes a response method, allowing you to return json responses or get access to the Origami\Api\Response class which offers a variety of helpers methods.
Responses
The Origami/Api/Response class offers a variety of helper methods and ultimately uses the Illuminate\Contracts\Routing\ResponseFactory Laravel class to return a json response with appropriate headers.
You can use the API Response class in your controller by using the response helper method:
or
Items or Collections
We make use of the excellent league/fractal PHP package to parse and transform Eloquent models and collections. For more information visit fractal.thephpleague.com
There are three helper methods on the response object
- resourceItem
- resourceCollection
- resourcePaginator
Full Example
Routes: app/Http/routes.php
Controller: app/Http/Controllers/Api/Items.php
Transformer: app/Items/ItemTransformer.php
License
All versions of api with dependencies
illuminate/support Version ^6.0|^7.0|^8.0|^9.0|^10.0
illuminate/contracts Version ^6.0|^7.0|^8.0|^9.0|^10.0
illuminate/http Version ^6.0|^7.0|^8.0|^9.0|^10.0
league/fractal Version ^0.19
nesbot/carbon Version ^2.0