PHPackages                             charlesportwoodii/yii2-api - 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. [Caching](/categories/caching)
4. /
5. charlesportwoodii/yii2-api

AbandonedLibrary[Caching](/categories/caching)

charlesportwoodii/yii2-api
==========================

Yii2 API Skeleton

1011[1 issues](https://github.com/charlesportwoodii/yii2-api/issues)PHPCI failing

Since Sep 11Pushed 5y ago3 watchersCompare

[ Source](https://github.com/charlesportwoodii/yii2-api)[ Packagist](https://packagist.org/packages/charlesportwoodii/yii2-api)[ RSS](/packages/charlesportwoodii-yii2-api/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependenciesVersions (1)Used By (0)

Yii2 API Skeleton Project
=========================

[](#yii2-api-skeleton-project)

[![Packagist Pre Release](https://camo.githubusercontent.com/75d36028a17b785d6a3d5778ecabd52ad8caadd8ca1c498d6a59f5fb7de4471e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f767072652f636861726c6573706f7274776f6f6469692f796969322d6170692e7376673f6d61784167653d38363430303f7374796c653d666c61742d737175617265)](https://packagist.org/packages/charlesportwoodii/yii2-api)[![TravisCI](https://camo.githubusercontent.com/dce5c143a5bb874f25e23897065f6383f107028033b79a3018d2edadded26305/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f636861726c6573706f7274776f6f6469692f796969322d6170692e7376673f7374796c653d666c61742d737175617265 "TravisCI")](https://travis-ci.org/charlesportwoodii/yii2-api)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/a5a4f380885d9b8d27d49ab5722dfcf444f9c53f71a7b95ebea32ea184e76159/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f636861726c6573706f7274776f6f6469692f796969322d6170692e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/charlesportwoodii/yii2-api/)[![Gittip](https://camo.githubusercontent.com/7b6c1b940cd79fa2a4fd030cb2b1b1c3ccb2c7fe675a2d691985bc75c35a7e51/68747470733a2f2f696d672e736869656c64732e696f2f6769747469702f636861726c6573706f7274776f6f6469692e7376673f7374796c653d666c61742d737175617265 "Gittip")](https://www.gittip.com/charlesportwoodii/)[![License](https://camo.githubusercontent.com/e891d5170f5fa6d4870f3b89820525dd9b646d33e38ceb1eb77c43e99e8fccb9/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4253442d6f72616e67652e7376673f7374796c653d666c61742d737175617265 "License")](https://github.com/charlesportwoodii/yii2-api/blob/master/LICENSE.md)[![Yii](https://camo.githubusercontent.com/caa07fe5c2d65aec86e62e1957ad3df612d53c4f055c8209179f12407e806242/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c61742d737175617265)](http://www.yiiframework.com/)

A project template to reduce the overhead involved in writing RESTful JSON API's by implementing common API endpoints (such as registration and authentication) so that developers can focus on writing core application business logic rather than implementing the same components over and over again. Built ontop of Yii Framework 2 (Yii2), this project provides a *basline* API skeleton that is easy to extend from, and implements a base API that can easily be extended from.

What is Provided?
-----------------

[](#what-is-provided)

By default the following functionality is provided:

- Authentication with HMAC+HKDF
- Registration
- Password Resets for authenticate and unauthenticated users

The additional functionality is provided as well:

- Two factor authentication via OTP codes + API endpoints to manage
- Configurable Rate Limiting
- Encrypted API session support via libsodium
- Translation support
- Develop with Docker

Documentation
-------------

[](#documentation)

For information on how to setup, configure, extend, and use this framework, please read the documentation in the [docs](docs) folder.

How to Contribute
-----------------

[](#how-to-contribute)

You can contribute to the development of the core API by submitting a new issue or pull request to this repository, or to the [yii2-api-rest-components](https://github.com/charlesportwoodii/yii2-api-rest-components), where the core components are stored. If you're looking for something to contribute to, consider the following ideas:

- Translations
- Implementing new API endpoints common to API's

License
-------

[](#license)

See [LICENSE.md](LICENSE.md) for licensing information.

###  Health Score

18

—

LowBetter than 8% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity33

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% 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.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/630969?v=4)[Charles R. Portwood II](/maintainers/charlesportwoodii)[@charlesportwoodii](https://github.com/charlesportwoodii)

---

Top Contributors

[![charlesportwoodii](https://avatars.githubusercontent.com/u/630969?v=4)](https://github.com/charlesportwoodii "charlesportwoodii (120 commits)")

---

Tags

disqueencryptionhkdflibsodiumqueueredisrestrest-apiyii2yii2-api

### Embed Badge

![Health badge](/badges/charlesportwoodii-yii2-api/health.svg)

```
[![Health](https://phpackages.com/badges/charlesportwoodii-yii2-api/health.svg)](https://phpackages.com/packages/charlesportwoodii-yii2-api)
```

###  Alternatives

[beryllium/cachebundle

Provides an interface to Memcache for Symfony2 applications

32136.0k](/packages/beryllium-cachebundle)

PHPackages © 2026

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