yiisoft/demo-api

This package is abandoned and no longer maintained. The author suggests using the yiisoft/demo package instead.

Yii Framework API project template

dev-master / 1.0.x-dev 2022-11-20 19:10 UTC

Requires

• php: ^8.1
• ext-intl: *
• cebe/markdown: ^1.2@dev
• cycle/database: ^2.0
• cycle/entity-behavior: ^1.0
• cycle/orm: ^2.0
• doctrine/collections: ^2.0
• httpsoft/http-message: ^1.0.5
• myclabs/php-enum: ^1.7
• psr/container: ^1.0|^2.0
• psr/http-factory: ^1.0
• psr/http-message: ^1.0
• psr/http-server-handler: ^1.0
• psr/http-server-middleware: ^1.0
• psr/log: ^3.0
• vlucas/phpdotenv: ^5.3
• yiisoft/access: ^1.0
• yiisoft/auth: ^3.0
• yiisoft/cache: ^2.0
• yiisoft/cache-file: ^2.0
• yiisoft/config: ^1.0
• yiisoft/data: ^3.0@dev
• yiisoft/data-response: ^1.0
• yiisoft/definitions: ^3.0
• yiisoft/di: ^1.0
• yiisoft/error-handler: ^2.0
• yiisoft/factory: ^1.0
• yiisoft/files: ^2.0
• yiisoft/http: ^1.2
• yiisoft/injector: ^1.0
• yiisoft/log: ^2.0
• yiisoft/log-target-file: ^2.0
• yiisoft/request-body-parser: ^1.1
• yiisoft/request-model: dev-master
• yiisoft/router: ^2.0
• yiisoft/router-fastroute: ^2.0
• yiisoft/security: ^1.0
• yiisoft/translator: ^2.0
• yiisoft/translator-message-php: ^1.1
• yiisoft/user: ^1.0
• yiisoft/validator: ^3.0@dev
• yiisoft/yii-console: ^1.0
• yiisoft/yii-cycle: ^3.0@dev
• yiisoft/yii-debug: ^3.0@dev
• yiisoft/yii-event: ^1.0
• yiisoft/yii-http: ^1.0
• yiisoft/yii-middleware: dev-master
• yiisoft/yii-queue: 3.0.x-dev
• yiisoft/yii-runner-console: ^1.0
• yiisoft/yii-runner-http: ^1.0
• yiisoft/yii-swagger: ^1.0

Requires (Dev)

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

BSD-3-Clause

• rest
• api
• app
• yii3

README

This package was closed and moved into https://github.com/yiisoft/demo.

❌

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