Download the PHP package sitesoft/laravel-apis without Composer

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

Informations about the package laravel-apis

Установка

1 . Установить через composer

2 . В файле config/app.php добавить в providers

3 . Чтобы разрешить CORS для всех api запросов, добавьте HandleCors middleware в $middlewareGroups в файле app/Http/Kernel.php: (См. раздел "Поддержка Cross-Origin Resource Sharing (CORS)")

4 . Опубликовать файл настроек apis.php из пакета:

Использование

Добавление нового проекта на Sitesoft APIS

где

например, если файлы вашего api находятся в папке app/Http/Controllers/Api/v1 то команда будет следующей:

эта команда сделает следующее:

  1. сгенерирует токен и запишет в файл config/apis.php
  2. добавит SwaggerController.php в app/Http/Controllers/Api/v1/
  3. добавит маршрут для swagger'а в файл routes/api.php
  4. сделает запрос к Sitesoft APIS на добавление нового проекта
  5. добавит в файл настроек apis.php путь для генерации swagger.json

Генерация swagger.json

Данный файл генерируется из ваших doc-блоков библиотекой swagger-php отдельно для каждой версии api.

Папки для генерации задаются в файле настроек config/apis.php в параметре paths. Swagger просканирует эти папки и создаст в каждой свой swagger.json.

Каждый такой файл должен быть доступен из вне, для этого при apis:create-project и apis:add-version по пути указанному в <path> создается файл SwaggerController.php

Поддержка Cross-Origin Resource Sharing (CORS)

Ваши api методы должны возвращать заговолок Access-Control-Allow-Origin для того, чтобы иметь возможность просмотреть ответ прямо на Sitesoft APIS.

Для поддержки CORS используется barryvdh/laravel-cors, для его работы достаточно выполнить пункт 3 из раздела Установка. Или вы можете включить CORS только для некоторых маршрутов:

или так

У модуля laravel-cors также есть возможность настройки https://github.com/barryvdh/laravel-cors#configuration

Добавление новой версии на Sitesoft APIS

где

например, если ваши файлы с новой версией api находятся в папке app/Http/Controllers/Api/v2 (относительно корня проекта) то команда будет следующей:

эта команда сделает следующее:

  1. добавит SwaggerController.php в app/Http/Controllers/Api/v2/
  2. добавит маршрут для swagger'а в файл routes/api.php
  3. сделает запрос к Sitesoft APIS на добавление новой версии проекта
  4. добавит в файл настроек apis.php путь для генерации swagger.json

All versions of laravel-apis with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4.0
zircote/swagger-php Version ^3.0
barryvdh/laravel-cors Version *
sitesoft/laravel-config-writer Version *
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 sitesoft/laravel-apis contains the following files

Loading the files please wait ....