PHPackages                             aqilix/zf3-apigilty-oauth2 - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. aqilix/zf3-apigilty-oauth2

ActiveLibrary[API Development](/categories/api)

aqilix/zf3-apigilty-oauth2
==========================

Start API Development using ZF3, Apigility with OAuth2 support

1.0.2(9y ago)813920BSD-3-ClausePHPPHP ^5.6 || ^7.0

Since Aug 25Pushed 8y ago9 watchersCompare

[ Source](https://github.com/aqilix/zf3-apigilty-oauth2)[ Packagist](https://packagist.org/packages/aqilix/zf3-apigilty-oauth2)[ Docs](https://aqilix.com/)[ RSS](/packages/aqilix-zf3-apigilty-oauth2/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependencies (26)Versions (14)Used By (0)

API Development using ZF3, Apigility with OAuth2 support
========================================================

[](#api-development-using-zf3-apigility-with-oauth2-support)

Requirements
------------

[](#requirements)

Please see the [composer.json](composer.json) file.

Installation
------------

[](#installation)

### Via Composer (create-project)

[](#via-composer-create-project)

You can use the `create-project` command from [Composer](http://getcomposer.org/)to create the project in one go (you need to install [composer](https://getcomposer.org/doc/00-intro.md#downloading-the-composer-executable)):

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

### Via Git (clone)

[](#via-git-clone)

First, clone the repository:

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

I have prepare [docker-compose.yml](docker-compose.yml), so you can use `docker-compose` to build this application.

```
docker-compose up -d

```

Install dependencies via the container:

```
docker-compose run api composer install

```

Manipulate dev mode from the container:

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

```

Creating Database

```
docker-compose run api composer development-db-create

```

Importing Data Fixtures

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

```

Or if you don't want to use `Docker`, you need to use [Composer](https://getcomposer.org/) to install dependencies. Assuming you already have Composer:

```
$ ./composer install
```

Configuration
-------------

[](#configuration)

There are several configuration files in `config/autoload/*.local.php.dist` need to be configured to use this application. And please remove `.dist` extension on the files. Example:

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

```

### Database Configuration

[](#database-configuration)

For database configuration, the related files need to be configured are:

- [local.php.dist](blob/master/config/autoload/local.php.dist)
- [doctrine.local.php.dist](blob/master/config/autoload/doctrine.local.php.dist)
- [oauth2.local.php.dist](blob/master/config/autoload/oauth2.local.php.dist) (this file also used to configure **OAuth2**)

### Email Transport Configuration

[](#email-transport-configuration)

To configure mail transport, please modify this file [mailtransport.local.php.dist](blob/master/config/autoload/mailtransport.local.php.dist). For this example, I use Mailgun you can use another mail service by configure `host`, `username` and `password`.

### Email Configuration

[](#email-configuration)

At the moment, there are 3 events send emails from this application.

- Signup (Welcome Email)
- Account Activated
- Request Reset Password

You can configure the **From**, **Sender Name**, and **Subject** from this file [user.local.php.dist](blob/master/config/autoload/user.local.php.dist)

### Project Configuration

[](#project-configuration)

For project configuration, there are 2 sections configuration. Those are `sites` and `php_process`. I think you just need to configure `sites` section to adjust with url on your site. And `php_process` is purposed to configure `cli`.

### CORS Configuration

[](#cors-configuration)

You can configure [zfr-cors](https://github.com/zf-fr/zfr-cors) on this file [zfr\_cors.local.php.dist](blob/master/config/autoload/zfr_cors.local.php.dist)

Run Application
---------------

[](#run-application)

After configure all configs, you can access this application from browser `http://localhost:8080` (I configure this container using port 8080).

If you have set this as `dev mode` you will see **Apigility Admin** on this url `http://localhost:8080/apigility/ui#/`

API Testing
-----------

[](#api-testing)

I use [Swagger](http://swagger.io/) for built in API Documentation. You can see it on `dev mode` by access this URL `http://localhost:8080/apigility/swagger`. You also can try the API Resources by using this Swagger

###  Health Score

33

—

LowBetter than 72% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community18

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 97.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~15 days

Recently: every ~35 days

Total

12

Last Release

3424d ago

Major Versions

0.09 → 1.0.02016-10-31

### Community

Maintainers

![](https://www.gravatar.com/avatar/c36d53ea05166d4ce18e3f043f2537901126a3840270f4ba11ff04cb24da880e?d=identicon)[dollyaswin](/maintainers/dollyaswin)

---

Top Contributors

[![dollyaswin](https://avatars.githubusercontent.com/u/107206?v=4)](https://github.com/dollyaswin "dollyaswin (136 commits)")[![man4red](https://avatars.githubusercontent.com/u/5639407?v=4)](https://github.com/man4red "man4red (2 commits)")[![sergiohermes](https://avatars.githubusercontent.com/u/1915564?v=4)](https://github.com/sergiohermes "sergiohermes (1 commits)")

---

Tags

apioauth2PHP7php56zf3apigility

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/aqilix-zf3-apigilty-oauth2/health.svg)

```
[![Health](https://phpackages.com/badges/aqilix-zf3-apigilty-oauth2/health.svg)](https://phpackages.com/packages/aqilix-zf3-apigilty-oauth2)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.5k5.9M719](/packages/sylius-sylius)[laravel/framework

The Laravel Framework.

34.8k543.8M19.5k](/packages/laravel-framework)[matomo/matomo

Matomo is the leading Free/Libre open analytics platform

21.6k38.2k](/packages/matomo-matomo)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.4M196](/packages/sulu-sulu)[algolia/algoliasearch-client-php

API powering the features of Algolia.

69735.1M148](/packages/algolia-algoliasearch-client-php)[kimai/kimai

Kimai - Time Tracking

4.8k8.7k1](/packages/kimai-kimai)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)