README

您可以通过以下命令使用此模板创建新项目：$>echo n | composer create-project evaneos/silex-rest-skeleton <your-project-name> -s dev

之后，您需要

1. 设置 git

$>composer git-setup git@github.com:<vendor-name>/<project-name>

您可以通过 git remote -v 查看所有远程信息

origin 指向您的应用程序仓库和上游的 silex 框架模板项目

1. 为 docker 设置环境

• 在 infrastructure/environment/dev/php/config 中，从 blackfire-agent.env.tpl 创建 blackfire-agent.env 文件以设置您的 blackfire 配置。
• 在 infrastructure/environment/dev/tunnel 中，从 db.env.tpl 创建 db.env 文件以设置连接到 DB 机器的 ssh 隧道。
• 构建 docker 镜像
  • 进入 infrastructure/dockerfiles 目录
  • 输入以下命令 $>make build
• 运行您的 docker 容器
  • 进入 infrastructure/environment\dev 目录
  • 输入以下命令 $>docker-compose up -d
• 要停止您的 docker 容器
  • 进入 infrastructure/environment\dev 目录
  • 输入以下命令 $>docker-compose kill
  • 输入以下命令 $>docker-compose rm -f

1. 设置和运行您的应用程序

• 在 config 中，创建 config.yml 文件以设置您的应用程序
• 要通过 http 访问您的应用程序（如果您的 docker 容器正在运行）
  • 输入以下命令 $>docker ps | grep rest-api-nginx 并查找类似以下字段的端口号：0.0.0.0:<your-port>->80tcp
  • 您的应用程序现在可通过 http://<your-machine-ip>:<your-port>/ 访问

1. 开始编码

• 将域代码放在 src 中
• 所有应用程序代码都将放在 app 中
  • 您的新控制器将放在 app/API/Controllers 中，并在 ServiceProvider 中声明
  • ControllerProviders 将放在 app/API/ControllerProviders 中，并在 ServiceProvider 中声明
  • 您的路由将通过 ControllerProviders 在 app/Application::mountRoutes 中挂载
  • 您的 API 资源将放在 app/API/Resources 中
  • 您的参数转换器将放在 app/API/Converters 中，并在 app/ServiceProviders/RestAPIServiceProvider 或新 ServiceProvider 中声明
  • 您的 ServiceProvider 将放在 app/ServiceProviders 中
  • 您的域服务将在新的 ServiceProvider 中声明，并在 app/Application::addDomainServices 中注册，或者直接在那里注册

1. 控制台

在目录根目录下，您将找到一个名为 console 的文件，它将允许您运行命令

要添加命令

• 在 app/Commands 中创建它
• 在 app/ServiceProviders/CommandsServiceProvider 中添加其声明，或添加一个新的 ServiceProvider
• 在 app/Application::bootCLI 中将命令添加到应用程序中