PHPackages                             grzegorz-jamroz/sf-api-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. [API Development](/categories/api)
4. /
5. grzegorz-jamroz/sf-api-bundle

ActiveLibrary[API Development](/categories/api)

grzegorz-jamroz/sf-api-bundle
=============================

Bundle provides basic features for Symfony Api.

8.0.1(2mo ago)01572PHP

Since May 18Pushed 2mo agoCompare

[ Source](https://github.com/grzegorz-jamroz/sf-api-bundle)[ Packagist](https://packagist.org/packages/grzegorz-jamroz/sf-api-bundle)[ RSS](/packages/grzegorz-jamroz-sf-api-bundle/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (10)Dependencies (9)Versions (15)Used By (2)

Ifrost Api Bundle for Symfony
=============================

[](#ifrost-api-bundle-for-symfony)

 **Bundle provides basic features for Symfony Api**

 [![Code Coverage](https://camo.githubusercontent.com/718638e74561829d8fd45e2fa6a81b22caea96edd96953db8adea509ff608654/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d3e3d382e342d626c75653f636f6c6f72423d253233383839324246)](https://camo.githubusercontent.com/718638e74561829d8fd45e2fa6a81b22caea96edd96953db8adea509ff608654/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d3e3d382e342d626c75653f636f6c6f72423d253233383839324246) [![Code Coverage](https://camo.githubusercontent.com/1434a1d9954c9a9a253b54c03e450e1a20f7e95858362c9fdeb905eab8a4bb81/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f7665726167652d3130302532352066696c65737c313030253235206c696e65732d627269676874677265656e)](https://camo.githubusercontent.com/1434a1d9954c9a9a253b54c03e450e1a20f7e95858362c9fdeb905eab8a4bb81/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f7665726167652d3130302532352066696c65737c313030253235206c696e65732d627269676874677265656e) [![Release Version](https://camo.githubusercontent.com/08a92a6cc7ec0ad1aee1813f89d7e816798b47a6ee7ebd7a3586daabe2b0b67b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f72656c656173652d76382e302e312d626c7565)](https://camo.githubusercontent.com/08a92a6cc7ec0ad1aee1813f89d7e816798b47a6ee7ebd7a3586daabe2b0b67b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f72656c656173652d76382e302e312d626c7565) [![Read License](https://camo.githubusercontent.com/ac5a84e46ed6115143e538fc1719317aee9a8da9fb0d842ad1bcbbc38cf6e79c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75653f7374796c653d666c61742d73717561726526636f6c6f72423d6461726b6379616e)](https://camo.githubusercontent.com/ac5a84e46ed6115143e538fc1719317aee9a8da9fb0d842ad1bcbbc38cf6e79c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75653f7374796c653d666c61742d73717561726526636f6c6f72423d6461726b6379616e)

Installation
============

[](#installation)

```
composer require grzegorz-jamroz/sf-api-bundle

```

---

Development with Docker
=======================

[](#development-with-docker)

### Build and run the containers:

[](#build-and-run-the-containers)

```
docker compose up -d
```

### Copy vendor folder from container to host

[](#copy-vendor-folder-from-container-to-host)

```
docker compose cp app:/app/vendor ./vendor
```

### Run static analysis

[](#run-static-analysis)

```
docker compose exec app bin/fix
```

### Run tests

[](#run-tests)

```
docker compose exec app bin/test
```

Run single test file:

```
docker compose exec app vendor/bin/phpunit --filter
docker compose exec app vendor/bin/phpunit --filter testShouldReturnExpectedFloat tests/Unit/TransformNumeric/ToFloatTest.php
```

### Enable xdebug

[](#enable-xdebug)

```
docker compose exec app xdebug on
```

### Disable xdebug

[](#disable-xdebug)

```
docker compose exec app xdebug off
```

### Run coverage report

[](#run-coverage-report)

1. [Enable xdebug](#enable-xdebug)
2. Run:

```
docker compose exec app bin/coverage
```

Usage
=====

[](#usage)

Add to your `config/routes.yaml` file

```
# config/routes.yaml

ifrost_api:
    resource: ../src/Action/
    type: ifrost_api
```

#### Default config

[](#default-config)

You can add `config/packages/ifrost_api.yaml` in your project to enable/disable some features if not necessary

```
# config/packages/ifrost_api.yaml
# You can enable/disable some features if not necessary
ifrost_api:
  api_request: true
  exception_listener: false
```

and from now you can add attribute `Symfony\Component\Routing\Annotation\Route` to your Action class for example:

```