Download the PHP package kodicms/laravel-api without Composer

On this page you can find all versions of the php package kodicms/laravel-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?

Example code of kodicms/laravel-api

Informations about the package laravel-api

Laravel Framework REST API

Пакет разработан для удобства работы с API запросами. На данный момент этот модуль предоставляет всего лишь контроллер, с набором методов, которые помогут организовать работу с AJAX запросами.

Установка

Добавить фасад в алиасы

'RouteAPI' => KodiCMS\API\RouteApiFacade::class,

Внести изменения в файл app\Exceptions\Handler.php

Описание

Контроллер

Контроллер необходимо наследовать от KodiCMS\API\Http\Controllers\Controller, после чего он начнет возвращать все ответы (ошибки и т.д.) в определенном формате с возможностью выбора типа ответа (json, xml, yaml):

Пример ответа:

{
    code: 200,
    content: '....',
    type: 'content',
    method: '...'
}

Коды ответов:

Тип ответа

Пример ответов с различным кодом в json формате

Полезные методы

Роутер

Для модуля API создан фассад RouteAPI который используется для добавления API роутов, который автоматически добавляет к новому маршруту возможность выбора типа ответа json, xml, yaml.

API запрос можно выполнить следующим образом:

Пример

Пример контроллера с возвращением данных

Пример контроллера с возвратом данных в произвольной форме

Пример контроллера с редиректом

Пример контроллера с выводом HTML

Исключения

API модуль имеет свой класс исключений KodiCMS\API\Exceptions\Exception от которого лучше всего наследовать исключения, которые используются в API контроллерах. Данный класс содержит метод responseArray, в котором содержится список параметров, которые попадут в Response

Пример кастомного класса исключений:

All versions of laravel-api with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5.9
laravel/framework Version 5.*
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 kodicms/laravel-api contains the following files

Loading the files please wait ...