{"id":19756804,"url":"https://github.com/imiphp/imi-project-http","last_synced_at":"2025-08-11T21:33:13.650Z","repository":{"id":49550322,"uuid":"202106774","full_name":"imiphp/imi-project-http","owner":"imiphp","description":"这是一个 imi http 项目开发骨架项目，你可以基于这个项目来开发你的项目。","archived":false,"fork":false,"pushed_at":"2023-07-17T06:19:13.000Z","size":36,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"2.1","last_synced_at":"2025-04-14T20:41:38.725Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.imiphp.com/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imiphp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-08-13T09:09:06.000Z","updated_at":"2024-12-16T03:20:41.000Z","dependencies_parsed_at":"2023-01-23T18:15:14.360Z","dependency_job_id":null,"html_url":"https://github.com/imiphp/imi-project-http","commit_stats":{"total_commits":36,"total_committers":2,"mean_commits":18.0,"dds":0.05555555555555558,"last_synced_commit":"c065a77ad07dca282a5d33053a05f9c219c2aaad"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imiphp%2Fimi-project-http","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imiphp%2Fimi-project-http/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imiphp%2Fimi-project-http/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imiphp%2Fimi-project-http/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imiphp","download_url":"https://codeload.github.com/imiphp/imi-project-http/tar.gz/refs/heads/2.1","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250869581,"owners_count":21500351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T03:16:58.528Z","updated_at":"2025-04-30T12:30:40.328Z","avatar_url":"https://github.com/imiphp.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 说明\r\n\r\n这是一个 imi http 项目开发骨架项目，你可以基于这个项目来开发你的项目。\r\n\r\nimi 框架：\u003chttps://www.imiphp.com\u003e\r\n\r\nimi 文档：\u003chttps://doc.imiphp.com\u003e\r\n\r\n## 安装\r\n\r\n创建项目：`composer create-project imiphp/project-http:~2.1.0`\r\n\r\n如果你希望在 php-fpm、Workerman 运行 imi：`已内置`\r\n\r\n如果你希望在 Swoole 运行 imi：`composer require imiphp/imi-swoole:~2.1.0`\r\n\r\n如果你希望在 RoadRunner 运行 imi：`composer require imiphp/imi-roadrunner:~2.1.0`\r\n\r\n\u003e RoadRunner 二进制文件请自行下载！\r\n\r\n## 配置\r\n\r\n### 项目命名空间\r\n\r\n默认是 `ImiApp`，可以在 `composer.json` 中修改：\r\n\r\n* `autoload.psr-4.ImiApp`\r\n\r\n* `imi.namespace`\r\n\r\n然后替换代码中的命名空间即可。\r\n\r\n### 运行配置\r\n\r\n项目配置目录：`config`\r\n\r\nHTTP 服务器配置目录：`ApiServer/config`\r\n\r\n## 启动服务\r\n\r\n**Swoole：**`vendor/bin/imi-swoole swoole/start` （强烈推荐）\r\n\r\n**Workerman：**`vendor/bin/imi-workerman workerman/start` （推荐）\r\n\r\n**RoadRunner：**`vendor/bin/imi-cli rr/start` （尝鲜）\r\n\r\n\u003e 切换环境运行前建议删除运行时文件目录：`rm -rf .runtime/*runtime`\r\n\r\n**PHP-FPM：**`vendor/bin/imi-cli fpm/start`（不推荐）\r\n\r\n建议在 FPM 模式下生成缓存：`vendor/bin/imi-cli imi/buildRuntime --app-namespace \"ImiApp\" --runtimeMode=Fpm`\r\n\r\n## 目录\r\n\r\n`.runtime` 是运行时文件读写目录，需要有可写权限\r\n\r\n`public` 是 php-fpm 站点根目录，不用可删除\r\n\r\n`rr` 是 RoadRunner 模式目录，不用可删除\r\n\r\n`Module` 是模块目录，一种推荐的目录组织方式。每个模块内部有自己的控制器、服务层、模型等。当然，你也可以根据你的喜好自己组织，imi 框架没有强制要求。\r\n\r\n内置的示例控制器目录在 `Module/Test/ApiController`。\r\n\r\n## 生产环境\r\n\r\n**关闭热更新：**`config/beans.php` 中 `hotUpdate.status` 设为 `false`\r\n\r\n生产环境建议只保留一个容器，可以提升性能，imi 官方推荐使用 **Swoole**！\r\n\r\n**移除 `imi-fpm`：**`composer remove imiphp/imi-fpm \u0026\u0026 rm -rf public`\r\n\r\n**移除 `imi-workerman`：**`composer remove imiphp/imi-workerman`\r\n\r\n**移除 `imi-roadrunner`：**`composer remove imiphp/imi-roadrunner \u0026\u0026 rm -rf rr \u0026\u0026 rm -f .rr.yaml`\r\n\r\n**移除 `imi-swoole`：**`composer remove imiphp/imi-swoole`（不推荐）\r\n\r\n## 代码质量\r\n\r\n### 格式化代码\r\n\r\n内置 `php-cs-fixer`，统一代码风格。\r\n\r\n配置文件 `.php-cs-fixer.php`，可根据自己实际需要进行配置，文档：\u003chttps://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/master/doc/config.rst\u003e\r\n\r\n**格式化项目：** `./vendor/bin/php-cs-fixer fix`\r\n\r\n**格式化指定文件：** `./vendor/bin/php-cs-fixer fix test.php`\r\n\r\n### 代码静态分析\r\n\r\n内置 `phpstan`，可规范代码，排查出一些隐藏问题。\r\n\r\n配置文件 `phpstan.neon`，可根据自己实际需要进行配置，文档：\u003chttps://phpstan.org/config-reference\u003e\r\n\r\n**分析项目：** `./vendor/bin/phpstan`\r\n\r\n**分析指定文件：** `./vendor/bin/phpstan test.php`\r\n\r\n### 测试用例\r\n\r\n内置 `phpunit`，可以实现自动化测试。\r\n\r\n**文档：**\u003chttps://phpunit.readthedocs.io/en/9.5/\u003e\r\n\r\n**测试用例 demo：**`tests/Module/Test/TestServiceTest.php`\r\n\r\n**运行测试用例：**`composer test`\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimiphp%2Fimi-project-http","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimiphp%2Fimi-project-http","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimiphp%2Fimi-project-http/lists"}