README

使用 Symfony、Doctrine、Maker Bundle、Migrations Bundle、Api-Platform 和 JWT-auth 开发的API入门套件。

套件已创建包含所有CRUD路由的User实体

套件包含3个Docker容器：php、nginx和mysql

安装

下载项目
composer create-project kadirov/api-starter-kit --ignore-platform-reqs --no-scripts

进入项目目录
cd api-starter-kit

运行Docker容器
docker compose up -d

安装composer脚本
docker compose exec php composer install

要安装项目，请运行命令
docker compose exec php bin/console ask:install

完成！您可以通过浏览器打开 https://:8507/api。顺便说一下，您可以通过更改.env文件中的DOCKER_NGINX_PORT变量来更改此端口号。

Docker

要进入php容器，请运行docker compose exec php bash

要进入mysql容器，请运行docker compose exec mysql bash

要进入nginx容器，请运行docker compose exec nginx bash

您可以通过更改.env文件中的DOCKER_PROJECT_NAME变量来更改容器的名称前缀。

此外，您还可以通过更改DOCKER_NGINX_PORT和DOCKER_DATABASE_PORT来更改nginx和mysql的公共端口

数据库只允许来自localhost的连接。因此，当您在生产环境中使用项目并需要从您的计算机连接到数据库时，您应该通过ssh桥接连接。

Cron

您可以使用docker/php/cron-file来设置cron任务。之后，您必须通过运行命令重新构建php容器
docker compose up -d --build

Swagger

您可以通过编辑文件config/packages/api_platform.yaml来更改项目名称和描述

Git Hook

如果您不使用任何部署系统，您可以这样做
cp docker/other-files/git/hooks/post-merge .git/hooks

这样，git始终执行命令bin/console ask:deploy。您可以在文件src/Command/AskDeployCommand.php中更改此命令。此命令将使用composer安装需求、清除缓存、更改./var和./public/media文件夹的所有权为www-data，并运行迁移。

JWT密钥

要使用Json Web Token系统，您必须创建私钥和公钥。它们在安装项目时已创建。您可以使用以下命令重新创建它们

bin/console ask:generate:jwtKeys

kadirov / api-starter-kit

维护者

详细信息