stfalcon-studio/api-bundle

Base classes and helper services to build API application via Symfony.

Installs: 7 595

Dependents: 0

Suggesters: 0

Security: 0

Stars: 6

Watchers: 4

Forks: 2

Open Issues: 0

Type:symfony-bundle


README

📦 Base classes and helper services to build API application via Symfony.

Scrutinizer Quality Score Build Status CodeCov License Latest Stable Version Total Downloads StyleCI

Installation

composer req stfalcon-studio/api-bundle

Add next dependencies if you want to use JWT auth

composer req gesdinet/jwt-refresh-token-bundle
composer req lexik/jwt-authentication-bundle

Check the config/bundles.php file

By default, Symfony Flex adds this bundle to the config/bundles.php file. In case when you ignored contrib-recipe during bundle installation it would not be added. In this case add the bundle manually.

# config/bundles.php

return [
    // Other bundles...
    StfalconStudio\ApiBundle\StfalconApiBundle::class => ['all' => true],
    // Other bundles...
];

Set Up Steps

Add mappings to Doctrine ORM config

doctrine:
    orm:
        mappings:
            StfalconApiBundle: ~

Set up a directory for JSON schemas

The default directory is ./src/Json/Schema/. Or you can change it via bundle configuration.

stfalcon_api:
    api_host: '%env(APP_API_HOST)%'
    json_schema_dir: '%kernel.project_dir%/src/Json/Schema/'
    jwt:
      enabled: true # set false to disable JWT auth 
      redis_client_jwt_black_list: "@snc_redis.jwt_black_list"

Contributing

Read the CONTRIBUTING file.