yiisoft/app-api

Yii Framework API project template

Fund package maintenance!
Open Collective
yiisoft

Installs: 525

Dependents: 0

Suggesters: 0

Security: 0

Stars: 36

Watchers: 15

Forks: 14

Open Issues: 3

Type:project

dev-master / 1.0.x-dev 2021-07-02 09:58 UTC

This package is auto-updated.

Last update: 2021-07-29 23:13:23 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii API template


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

API application template 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