Yii API template

API application template for Yii 3.

Requirements

• PHP 8.1 or higher.

Installation

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.

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

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

The template comes with ready to use Codeception configuration. In order to execute tests run:

composer run serve > ./runtime/yii.log 2>&1 &
vendor/bin/codecept run

Static analysis

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

./vendor/bin/psalm

License

The Yii API template is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Follow updates