mareksokol/silex-bootstrap

Silex基于API的Bootstrap

2.1.0 2017-12-03 03:52 UTC

This package is not auto-updated.

Last update: 2024-09-25 08:23:58 UTC


README

Build Status

Silex-bootstrap是一个已经配置好的Silex项目,专为轻量级、RESTful API设计。

安装

要开始一个新项目,运行

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

您还需要在根目录创建配置文件

cp config.php.dist config.php

目录结构

目录结构如下

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

bin/存放所有可执行文件,例如命令行工具

src/是应用程序的根目录,包含应用程序文件:控制器、实体、迁移、仓库、服务、提供者和引导文件

storage/所有静态文件,包括应用程序日志

test/包含单元测试

web/包含所有公开的内容 - HTTP服务器应配置为将此位置作为根

使用

配置

所有配置都应放置在config.php文件中。要定义新的配置参数,需要在App\Service\Provider\ConfigServiceProvider::$config中添加定义。

控制器

控制器应继承自App\Controller\AbstractController - 此类实现了几个辅助方法,以简化API的输出。要注册新的控制器,需要在App\Bootstrap::loadControllers()中添加声明。

路由

路由在App\Bootstrap::routes()中定义。

服务

服务通过服务提供者在App\Bootstrap::loadServices()中注册。自定义服务提供者应放置在App\Service\Provider命名空间中。

数据库

所有数据库机制都基于Doctrine2框架。有一个专门的命名空间App\Entity用于所有Doctrine类(实体、仓库:App\Entity\Repository和迁移:App\Entity\Migrations)。