Download the PHP package eilander/api without Composer

On this page you can find all versions of the php package eilander/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package api

Laravel 5 Api

Hi, this is a api package for Laravel 5.

Table of contents

[TOC]

Step 1: Add the Service Provider

In your config/app.php add Eilander\Api\Providers\ApiServiceProvider:class to the end of the providers array:

Step 2: Add package to composer.json for autoloading

Add the package to the main composer.json for autoloading and run composer dump-autoload, like so:

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.

version

This is the current version of your api

route

This array of arrays helps when setting up routes in your Laravel routes.php file. We adopt a prefix of api/v1 by default.

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 a Middleware class

Eilander\Api\Http\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.

Send a header x-api-key = secrtekey with the api request to validate against the routes.

Controllers

We provide a helpful BaseController base controller class that includes a response method, allowing you to return json responses or get access to the Eilander\Api\Response class which offers a variety of helpers methods.

This base controller extend from the base laravel controller in App\Http\Controllers\Controller. Don't remove this class.

There are some other controller implementation available that extend the *BaseController. At the time of writing these are:

GatewayController Api controller with some default functionality that implements the gateway pattern. Have a look at Eilander\Api\Http\Controllers\GatewayController for all the available methods.

Responses

The Eilander/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

InternalRequests

The Eilander/Api/InternalRequests class handles internal requests against the api. Say you have an api module and an admin model then the admin model can digest every api endpoint in de api module.

All requests should have a uri to match the endpoint and can have params to send with the request.

That's all, no further configuration needed.


All versions of api with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5.9
laravel/framework Version 5.1.*|5.2.*
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package eilander/api contains the following files

Loading the files please wait ....