PHPackages                             digitalstars/simple-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. digitalstars/simple-api

ActiveLibrary[API Development](/categories/api)

digitalstars/simple-api
=======================

Библиотека для простого создания POST/GET API

v1.0.0(5y ago)1215731MITPHPPHP >=7.0

Since Jul 30Pushed 2y ago1 watchersCompare

[ Source](https://github.com/digitalstars/simple-api-php)[ Packagist](https://packagist.org/packages/digitalstars/simple-api)[ RSS](/packages/digitalstars-simple-api/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (10)DependenciesVersions (13)Used By (1)

SimpleAPI
=========

[](#simpleapi)

Подключение
-----------

[](#подключение)

`composer require digitalstars/simple-api`

Как с этим работать
-------------------

[](#как-с-этим-работать)

Скрипту обязательно должен приходить параметр module с названием модуля.

- Первый параметр - название модуля
- Остальные параметры - необходимые данные. Если в функции params поставить ? перед параметром, то он считается необязательным
- В массив answer добавляются необходимые данные для фронта. В конце выполнения кейса, библиотека автоматически вызывает деструктор и данные в json формате отправляются фронту.
- если вам удобнее передавать много данный в json формате, то передавайте чистый json вместе с модулем в тело POST запроса
- breake в кейсах ставить не надо, будет и без них нормально работать. Если не нравится инспекции в IDE о пропущенном break, то просто выключите его
- если в answer передать массив, он автоматически конвертируется в json
- OPTIONS запросы игнорируются(полезно если, запросы идут от react/vue/etc)
- есть метод error, в который передается текст. Этот метод завершает скрипт и возвращает на фронт json вида: `{"error":"ваш текст"}`
- Если не указать хотя бы один из необходимых параметров, то вернется json: `{"error":"missed params"}`

Пример №1 Обычное использование
-------------------------------

[](#пример-1-обычное-использование)

GET Запрос:
`site.ru/api.php?module=auth&login=admin&password=admin`

```