PHPackages                             wakeapp/api-platform-bundle - 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. [HTTP & Networking](/categories/http)
4. /
5. wakeapp/api-platform-bundle

AbandonedArchivedSymfony-bundle[HTTP & Networking](/categories/http)

wakeapp/api-platform-bundle
===========================

Extends Symfony HttpFoundation and provides encapsulated area for work with REST API

v2.0.13(5y ago)822.7kMITPHPPHP ~7.1||~8.0

Since Aug 30Pushed 4y ago1 watchersCompare

[ Source](https://github.com/wakeapp/api-platform-bundle)[ Packagist](https://packagist.org/packages/wakeapp/api-platform-bundle)[ RSS](/packages/wakeapp-api-platform-bundle/feed)WikiDiscussions master Synced 4d ago

READMEChangelog (10)Dependencies (8)Versions (33)Used By (0)

Api Platform Bundle
===================

[](#api-platform-bundle)

[![Latest Stable Version](https://camo.githubusercontent.com/55efa2229474111d7707ad34ec75fc4209ce304e146274e275c3c0a417df8942/68747470733a2f2f706f7365722e707567782e6f72672f77616b656170702f6170692d706c6174666f726d2d62756e646c652f762f737461626c65)](https://packagist.org/packages/wakeapp/api-platform-bundle)[![Total Downloads](https://camo.githubusercontent.com/39f35cbffb6c0f6ee0d7c7c19c16e46e196a6890f426eba2d212b5ab24ad1c7a/68747470733a2f2f706f7365722e707567782e6f72672f77616b656170702f6170692d706c6174666f726d2d62756e646c652f646f776e6c6f616473)](https://packagist.org/packages/wakeapp/api-platform-bundle)

Введение
--------

[](#введение)

Бандл расширяет компонет Symfony [http-foundation](https://github.com/symfony/http-foundation) позволя выделить работу с API в отдельную инкапсулированную зону.

Предоставляется работа с контентом запроса в формате `JSON` посредством `ParameterBag`. Архитектура бандла не допускает фатального падения в зоне API и всегда возвращает валидный ответ с соответствующем кодом ошибки. Полный список кодов ошибок доступен в виде констант в классе [ApiException](./Exception/ApiException.php).

Для описания спецификации API обязательно использование [Swagger 2](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md)в одном из форматов:

- [NelmioApiDocBundle](https://github.com/nelmio/NelmioApiDocBundle).
- [swagger-php](https://github.com/zircote/swagger-php).
- Использование файла конфигурации в формате `json` или `yaml` (`yml`).

Установка
---------

[](#установка)

### Шаг 1: Загрузка бандла

[](#шаг-1-загрузка-бандла)

Откройте консоль и, перейдя в директорию проекта, выполните следующую команду для загрузки наиболее подходящей стабильной версии этого бандла:

```
    composer require wakeapp/api-platform-bundle
```

*Эта команда подразумевает что [Composer](https://getcomposer.org) установлен и доступен глобально.*

### Шаг 2: Подключение бандла

[](#шаг-2-подключение-бандла)

После включите бандл добавив его в список зарегистрированных бандлов в `app/AppKernel.php` файл вашего проекта:

```