README

适用于使用 Slim PHP 微框架开发 RESTful API 的有用骨架。

💻 使用的技术

本项目中使用的主要技术包括

PHP 8
Slim 4
MySQL
PHPUnit
dotenv
Docker
Docker Compose

⚙️ 快速安装

要求

Composer.
PHP >= 8.1
MySQL/MariaDB.
或 Docker.

使用 Composer

您可以通过运行以下命令创建一个新项目

composer create-project maurobonfietti/slim4-api-skeleton [my-api-name]
cd [my-api-name]
composer test
composer start

配置与 MySQL 服务器的连接

默认情况下，API 使用 MySQL 数据库。

您应该在您的 .env 文件中检查和编辑此配置

DB_HOST='127.0.0.1'
DB_NAME='yourMySqlDatabase'
DB_USER='yourMySqlUsername'
DB_PASS='yourMySqlPassword'
DB_PORT='3306'

使用 Docker

如果您喜欢 Docker，您可以使用此项目与 Docker 和 Docker Compose 一起使用。

最小 Docker 版本

Engine: 18.03+
Compose: 1.21+

Docker 命令

# Create and start containers for the API.
docker-compose up -d --build

# Checkout the API.
curl https://:8081

# Stop and remove containers.
docker-compose down

📦 依赖项

依赖项列表

slim/slim: Slim 是一个 PHP 微框架，可以帮助您快速编写简单而强大的 Web 应用程序和 API。
slim/psr7: 用于 Slim 4 的 PSR-7 实现。
pimple/pimple: 一个小巧的 PHP 依赖注入容器。
vlucas/phpdotenv: 从 .env 文件自动加载环境变量到 getenv()、$_ENV 和 $_SERVER。

开发依赖项列表

phpunit/phpunit: PHP 单元测试框架。
symfony/console: 控制台组件简化了美观且可测试的命令行界面的创建。
nunomaduro/phpinsights: 从您的控制台进行即时 PHP 质量检查。
maurobonfietti/slim4-api-skeleton-crud-generator: 为 Slim 4 - Api Skeleton 生成 CRUD。

🔖 端点

默认情况下

Hello: GET /
健康检查: GET /status

📹 指南

通过观看此视频学习如何使用 PHP 和 Slim 4 开发 RESTful API [🎥 🔈 🇪🇸 🇦🇷]

Desarrollar.una.API.RESTful.con.PHP.y.Slim.4.mp4

❤️ 支持项目

如果您想支持此项目，您可以

邀请作者喝杯咖啡 ☕ 😋
给仓库加个星标 ⭐ 😊

😎 就这些了！

现在，去构建一个出色的 RESTful API 吧。

maurobonfietti / slim4-api-skeleton

维护者

详细信息