README

Yii API template

API application template for Yii 3.

If you do not have Composer, you may install it by following the instructions at getcomposer.org.

Create a project:

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

To run the app:

./yii serve

Now you should be able to access the application through the URL printed to console. Usually it is https://127.0.0.1:8080.

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

Fork the repository, clone it, then:

cd myproject
make composer update

To run the app:

make up

To stop the app:

make down

The application is available at https://localhost. 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.

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.

The template comes with ready to use Codeception configuration. To execute tests, in local installation run:

./vendor/bin/codecept build

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

For Docker:

make codecept build

make codecept run

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

./vendor/bin/psalm

or, using Docker:

make psalm

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.