romkatsu/demo-api

Yii Framework API Demo Project

API Demo application for Yii 3.

Installation

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:

./vendor/bin/psalm