README

:项目名称

此存储库可用于构建新的 Laravel API。按照以下步骤开始：

1. 在您的终端运行以下命令

composer create-project 3sidedcube/laravel-api-template project-name -s dev

1. 然后通过运行以下命令配置您的 Laravel 服务

php artisan sail:install

1. 更新 bitbucket-pipelines.yml 文件以使用任何附加服务
2. 确保供应和部署信息正确
3. 在项目空间上创建一个 Backend API confluence 页面以编写有用的文档（记得更新 README）
4. 将任何对 project_name 的引用替换为您的项目名称。您需要更新以下文件
   1. composer.json（名称）
   2. README.md（标题）
   3. 环境变量（.env，.env.example，.env.pipelines）
   4. OpenAPI（v1.json）
   5. 变更日志
5. 将下面的环境信息更新为正确的 URL

这里应该是您的描述。限制为一两段话。

环境

此项目有几个可用环境。

生产

https://project-api.com

此环境仅应用于生产构建。在部署到该环境之前，API 的更改应该已经过测试。

预发布

https://project-api.com

一旦 API 完成内部测试，它应该部署到此环境。然后将在 UAT 期间由客户端使用。

注意：请确保 UAT 总是使用此环境，以便可以在 UAT 进行的同时部署错误修复和更改。

测试

https://project-api.com

测试环境应用于内部测试 API。为测试团队构建的所有移动构建也应指向此环境。

开发

https://project-api.com

此环境可供移动开发者或前端开发者在本地开发新功能时使用。拥有此环境有助于开发者在 API 变更部署到测试环境之前修复任何破坏性更改。

本地开发

此项目使用 Laravel Sail 进行本地开发，它使用 Docker。您需要确保您已安装并运行 Docker。

首次设置

1. 复制示例环境文件

cp .env.example .env

1. 安装 Composer 依赖项

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v $(pwd):/opt \
    -w /opt \
    laravelsail/php81-composer:latest \
    composer install --ignore-platform-reqs

1. 运行以下命令

./vendor/bin/sail up -d
./vendor/bin/sail artisan key:generate
./vendor/bin/sail artisan migrate
./vendor/bin/sail artisan db:seed

1. API 现在应在 https:// 上可用。

停止项目

1. 要停止项目 Docker 容器，只需运行以下命令

./vendor/bin/sail down

重新启动项目

1. 在首次使用完成后，要重新启动项目 Docker 容器，只需运行以下命令

./vendor/bin/sail up -d

注意事项

如果您在此项目上遇到问题，以下是一些有用的提示

供应

服务器供应由 Laravel Forge 处理。

部署

要部署此项目，请登录到 Envoyer 并在相应的项目中单击“部署”。

文档

所有文档都可以在以下 页面 在 confluence 中找到。

日志

我们使用 Sentry 来跟踪不同环境中的日志。

测试

您可以通过运行以下命令来运行完整的测试套件

make test