This package is abandoned and no longer maintained. The author suggests using the yiisoft/demo package instead.

Yii Framework API project template

Fund package maintenance!
Open Collective

Installs: 14

Dependents: 0

Suggesters: 0

Security: 0

Stars: 28

Watchers: 14

Forks: 8

Open Issues: 1


dev-master / 1.0.x-dev 2022-11-20 19:10 UTC


This package was closed and moved into https://github.com/yiisoft/demo.


Yii Framework API Demo Project

Latest Stable Version Total Downloads Build status Scrutinizer Code Quality static analysis

API Demo application for Yii 3.


Install docker:

docker-compose up -d

Enter into the container:

docker exec -it yii-php bash

Install packages:

composer install

Change ownership of the app directory to web group:

chown -R :www-data .

Usually the application is available at http://localhost:8080.

Authorization is performed via the X-Api-Key header.

API documentation

API documentation is available at /docs. It is built from OpenAPI annotations (@OA). See Swagger-PHP documentation for details on how to annotate your code.

Codeception testing

./vendor/bin/codecept run

Static analysis

The code is statically analyzed with Psalm. To run static analysis: