yiisoft/app-api

Yii Framework API project template

dev-master / 1.0.x-dev 2023-10-18 10:25 UTC

Requires

• php: ^8.1
• cebe/markdown: ^1.2@dev
• httpsoft/http-message: ^1.1
• psr/container: ^2.0
• psr/http-factory: ^1.0
• psr/http-message: ^1.1|^2.0
• psr/http-server-handler: ^1.0
• psr/http-server-middleware: ^1.0
• psr/log: ^3.0
• vlucas/phpdotenv: ^5.3
• yiisoft/config: ^1.0
• yiisoft/data: ^1.0
• yiisoft/data-response: ^2.0
• yiisoft/definitions: ^3.0
• yiisoft/di: ^1.2
• yiisoft/error-handler: ^3.0
• yiisoft/factory: ^1.1
• yiisoft/files: ^2.0
• yiisoft/http: ^1.2
• yiisoft/hydrator: dev-master
• yiisoft/hydrator-validator: dev-master
• yiisoft/injector: ^1.1
• yiisoft/input-http: dev-master
• yiisoft/log: ^2.0
• yiisoft/log-target-file: ^3.0
• yiisoft/middleware-dispatcher: ^5.2
• yiisoft/request-body-parser: ^1.1
• yiisoft/router: ^3.0
• yiisoft/router-fastroute: ^3.0
• yiisoft/validator: ^1.0
• yiisoft/yii-console: ^2.0
• yiisoft/yii-debug: ^3.0@dev
• yiisoft/yii-event: ^2.0
• yiisoft/yii-http: ^1.0
• yiisoft/yii-middleware: ^1.0
• yiisoft/yii-runner-console: ^2.0
• yiisoft/yii-runner-http: ^2.0
• yiisoft/yii-swagger: ^2.0

Requires (Dev)

• codeception/c3: ^2.6
• codeception/codeception: ^5.0
• codeception/lib-innerbrowser: ^3.0
• codeception/module-asserts: ^3.0
• codeception/module-cli: ^2.0
• codeception/module-db: ^3.0
• codeception/module-phpbrowser: ^3.0
• codeception/module-rest: ^3.0
• phpunit/phpunit: ^9.5
• roave/infection-static-analysis-plugin: ^1.16
• spatie/phpunit-watcher: ^1.23
• vimeo/psalm: ^4.30|^5.8
• yiisoft/json: ^1.0
• yiisoft/yii-debug-api: ^3.0@dev
• yiisoft/yii-debug-viewer: ^3.0@dev
• yiisoft/yii-testing: dev-master

BSD-3-Clause

• rest
• api
• app
• yii3

README

Yii API template

API application template for Yii 3.

Installation

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

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