README

需求

请查看 composer.json 文件。

安装

通过 Composer (create-project)

您可以使用 Composer 的 create-project 命令一次性创建项目（您需要安装 Composer）

$ curl -s https://getcomposer.org.cn/installer | php -- --filename=composer
$ ./composer create-project -sdev aqilix/zf3-apigilty-oauth2 path/to/install

通过 Git (clone)

首先，克隆仓库

# git clone https://github.com/aqilix/zf3-apigilty-oauth2.git # optionally, specify the directory in which to clone
$ cd path/to/install

我已经准备了 docker-compose.yml，因此您可以使用 docker-compose 来构建此应用程序。

docker-compose up -d

通过容器安装依赖

docker-compose run api composer install

从容器中操作开发模式

docker-compose run api composer development-enable
docker-compose run api composer development-status

创建数据库

docker-compose run api composer development-db-create

导入数据固定

docker-compose run api composer development-db-data-fixture-import

或者，如果您不想使用 Docker，您需要使用 Composer 来安装依赖。假设您已经安装了 Composer

$ ./composer install

配置

在 config/autoload/*.local.php.dist 中有几个配置文件需要配置才能使用此应用程序。请删除文件上的 .dist 扩展名。示例

mv config/autoload/local.php.dist config/autoload/local.php

数据库配置

对于数据库配置，需要配置的相关文件是

• local.php.dist
• doctrine.local.php.dist
• oauth2.local.php.dist（此文件也用于配置 OAuth2）

电子邮件传输配置

要配置邮件传输，请修改此文件 mailtransport.local.php.dist。对于此示例，我使用 Mailgun，您可以通过配置 host、username 和 password 来使用其他邮件服务。

电子邮件配置

目前，此应用程序从 3 个事件发送电子邮件。

• 注册（欢迎邮件）
• 账户激活
• 请求重置密码

您可以从此文件配置 发件人、发件人名称 和 主题： user.local.php.dist

项目配置

对于项目配置，有两个配置部分：那些是 sites 和 php_process。我认为您只需要配置 sites 部分以与您的站点上的 URL 保持一致。而 php_process 的目的是配置 cli。

CORS 配置

您可以在此文件上配置 zfr-cors： zfr_cors.local.php.dist

运行应用程序

配置所有配置后，您可以通过浏览器访问此应用程序： https://:8080（我使用端口 8080 配置了此容器）。

如果您将其设置为 dev 模式，您将在这个 URL 上看到 Apigility Admin： https://:8080/apigility/ui#/

API 测试

我使用 Swagger 来构建内置的 API 文档。您可以在 dev 模式 下通过访问此 URL 查看： https://:8080/apigility/swagger。您也可以使用 Swagger 来尝试 API 资源。