bednic/api-skeleton

SlimPHP + Doctrine2 ORM + PHP DI + JSON API 框架,用于构建 RESTful API。

安装: 12

依赖: 0

建议者: 0

安全: 0

星标: 0

分支: 0

类型:项目

0.1.1 2020-10-30 14:46 UTC

This package is auto-updated.

Last update: 2024-08-29 05:06:47 UTC


README

此框架提供了 JSON API 的设置。它基于 Slim 4、Doctrine 2、PHP DI 和 JSON API 库。

安装

$ composer create-project bednic/api-skeleton <path> "0.1.*"

自定义 DI 配置文件

如果您想使用自己的 DI 配置或覆盖当前的配置,只需将文件(如 di-config.local.php)添加到 /config 文件夹中。这将覆盖默认的 DI 配置。

自定义 ENV

您可以通过自己的 .env 文件覆盖环境变量。只需创建自己的文件,例如 .env.local

结构

├───/app
│   ├───/Controller
│   ├───/Factory
│   ├───/Migration
│   ├───/Model
│   │   ├───/Entity
│   │   └───/Repository
│   └───/Service
│
├───/cache
├───/config
├───/log
├───/public
├───/tmp
└───/vendor

Docker

您可以通过 Docker 开发

docker build -t . && docker run -p 80:80 -v /path/to/project:/var/www --name api

Docker Compose

docker-composer up -d

如果您想使框架从启动时就能工作,有一些事情您必须做。

docker exec -it api vendor/bin/doctrine orm:generate:proxies
docker exec -it api vendor/bin/doctrine-migrations migrate

api 是 API 容器的名称。迁移请求确认时,请回答“是”。

完成这些步骤后,您应该有一个可工作的 API,只需访问 https://。您应该看到生成的 OAS 架构。

问题