Yii Framework API project template

Fund package maintenance!
Open Collective

Installs: 880

Dependents: 0

Suggesters: 0

Security: 0

Stars: 63

Watchers: 19

Forks: 28

Open Issues: 7


dev-master / 1.0.x-dev 2024-04-30 13:02 UTC

This package is auto-updated.

Last update: 2024-04-30 13:02:37 UTC



Yii API template

Latest Stable Version Total Downloads build Scrutinizer Code Quality codecov static analysis

API application template for Yii 3.


  • PHP 8.1 or higher.


Creating a project:

composer create-project yiisoft/app-api --stability=dev myproject
cd myproject

Install docker:

docker-compose up -d

Enter into the container:

docker-compose exec php bash

Install packages:

composer install

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: