mareksokol/silex-bootstrap

Bootstrap for Silex based API

Silex-bootstrap

, _(*1)

Silex-bootstrap is an already setup Silex project dedicated for lightweight, RESTful APIs., _(*2)

Installation

To start a new project, run:, _(*3)

composer create-project mareksokol/silex-bootstrap <target-dir>

You need also to create config file in root directory:, _(*4)

cp config.php.dist config.php

Directory structure

The directory structure is the following, _(*5)

bin/
src/
  Controller/
  Entity/
    Migrations/
    Repository/
  Service/
    Provider/
storage/
    logs/
    proxies/
tests/
web/

bin/ place for all executables, eg. command line tool, _(*6)

src/ is the root of application, contains application files: controllers, entities, migrations, repositories, services, providers and bootstrap file, _(*7)

storage/ all static files, including application logs, _(*8)

test/ contains unit tests, _(*9)

web/ contains everything which is exposed - HTTP server should be configured to point this place as root, _(*10)

Usage

Configuration

All configuration should be places in config.php file. To define new configuration parameters need to add definition in App\Service\Provider\ConfigServiceProvider::$config., _(*11)

Controllers

Controllers should inherit from App\Controller\AbstractController - this class implements several helper methods to simplify output from API. To register new controller need to add declaration in App\Bootstrap::loadControllers()., _(*12)

Routes

Routes are defined in App\Bootstrap::routes()., _(*13)

Services

Services are registered via service providers in App\Bootstrap::loadServices(). Custom service providers should be placed in App\Service\Provider namespace., _(*14)

Database

All database mechanism is based on Doctrine2 framework. There is dedicated namespace App\Entity for all doctrine classes (entities, repositories: App\Entity\Repository and migrations: App\Entity\Migrations)., _(*15)