通过
搜索
搜索yiisoft / app-api
Yii 框架 API 项目模板
dev-master / 1.0.x-dev
2024-07-09 07:01 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
- symfony/console: ^6.0
- vlucas/phpdotenv: ^5.3
- yiisoft/cache-file: ^3.0
- 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: ^1.0
- yiisoft/hydrator-validator: ^2.0
- yiisoft/injector: ^1.1
- yiisoft/input-http: ^1.0
- 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: dev-master
- 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
- maglnet/composer-require-checker: ^4.7
- phpunit/phpunit: ^9.5
- rector/rector: ^1.0.0
- roave/infection-static-analysis-plugin: ^1.34
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^5.20
- yiisoft/json: ^1.0
- yiisoft/yii-debug-api: dev-master
- yiisoft/yii-debug-viewer: dev-master
- yiisoft/yii-testing: dev-master
This package is auto-updated.
Last update: 2024-09-09 07:17:10 UTC
README
Yii API 模板
Yii 3 的 API 应用模板。
要求
- PHP 8.1 或更高版本。
安装
创建项目
composer create-project yiisoft/app-api --stability=dev myproject
cd myproject
安装 docker
docker-compose up -d
进入容器
docker-compose exec php bash
安装包
composer install
通常应用在 http://localhost:8080 可用。
授权通过 X-Api-Key 标头执行。
如果您需要帮助或有问题，Yii 论坛 是一个好去处。您还可以查看其他 Yii 社区资源。
API 文档
API 文档位于 /docs。它由 OpenAPI 注释（@OA）构建。
有关如何注释代码的详细信息，请参阅 Swagger-PHP 文档。
Codeception 测试
模板附带现成的 Codeception 配置。要执行测试，请运行
composer run serve > ./runtime/yii.log 2>&1 & vendor/bin/codecept run
静态分析
代码使用 Psalm 进行静态分析。要运行静态分析
./vendor/bin/psalm
许可证
Yii API 模板是自由软件。它根据 BSD 许可证发布。有关更多信息，请参阅 LICENSE。
由 Yii 软件 维护。
支持项目
关注更新