API application template for Yii 3.

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 is available at /docs. It is built from OpenAPI annotations (@OA). See Swagger-PHP documentation for details on how to annotate your code.

./vendor/bin/codecept run

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

./vendor/bin/psalm