yiisoft/demo-api

Yii Framework API project template

Fund package maintenance!
Open Collective
yiisoft

Installs: 13

Dependents: 0

Suggesters: 0

Security: 0

Stars: 22

Watchers: 14

Forks: 7

Open Issues: 5

Type:project

dev-master / 1.0.x-dev 2022-01-17 21:28 UTC

README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii Framework API Demo Project


Latest Stable Version Total Downloads Build status Scrutinizer Code Quality static analysis

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

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