roaresearch/yii2-roa

Yii 2 ROA 库

安装次数: 1,468

依赖: 2

建议者: 0

安全性: 0

星星: 0

关注者: 3

分支: 2

开放问题: 0

类型:yii2-extension

4.1.0 2022-11-23 22:35 UTC

This package is auto-updated.

Last update: 2024-09-05 19:18:12 UTC


README

该库包含构建 ROA 应用程序的模块和控制器,使用 Yii2 框架。

Latest Stable Version Total Downloads Code Coverage Scrutinizer Code Quality

Scrutinizer Build Status Scrutinizer

先决条件

  • 安装 PHP 8.1 或更高版本
  • 已安装 Composer
  • 运行命令 composer check-platform-reqs 检查所有要求。

安装

在 Yii2 App Advanced 项目上安装

创建新项目

运行测试

本节旨在运行此库的测试,要在您的应用程序上运行测试,请检查 Yii2 App Roa 测试

配置测试

测试已预先配置,除了数据库凭据外。要配置数据库凭据,创建一个包含 Yii2 对 Yii::$app->db 组件配置的文件 tests/_app/config/db.local.php。示例

return [
    'dsn' => ..., 
    'username' => ..., 
    'password' => ..., 
];

请确保创建一个数据库以加载迁移,默认名称为 yii2_roa_test

部署测试

该库包含一个 composer 脚本来部署测试。

composer deploy-tests

运行测试

该库还包括 2 个 composer 脚本来轻松运行测试。

  • composer run-tests 运行所有 codeception 测试。
  • composer run-coverage 运行所有 codeception 测试并生成覆盖率报告

编写测试

您可以在 tests/ 文件夹中编写新的测试,遵循 codeception 文档

示例

Yii2 ROA Live Demo

您可以在新安装的项目上运行实时演示,以帮助您运行测试或了解服务器返回的响应。

composer yii -- serve [yii2Options]

https://yiiframework.cn/doc/api/2.0/yii-console-controllers-servecontroller

然后在您的浏览器中访问路由 https://:8080/index.php/api

其他库

您可以使用以下存储库并使用它们提供的实时演示

用例

待办事项

构建工具

行为准则

请阅读 CODE_OF_CONDUCT.md 了解我们的行为准则详情。

贡献

请阅读 CONTRIBUTING.md 了解向我们提交拉取请求的流程详情。

版本控制

我们使用 SemVer 进行版本控制。有关可用版本,请参阅此存储库的 标签

考虑到 SemVer 版本控制规则 9、10 和 11 中提到了预发布版本,它们将不会在 ROAResearch 中使用。

作者

也可以参考参与此项目的 贡献者名单

许可证

本项目采用 MIT 许可证 - 有关详细信息,请参阅 LICENSE.md 文件。