{"id":13793006,"url":"https://github.com/kuafuRace/phprap","last_synced_at":"2025-05-02T22:31:28.473Z","repository":{"id":105781518,"uuid":"161006183","full_name":"kuafuRace/phprap","owner":"kuafuRace","description":"PHPRAP，是一个PHP轻量级开源API接口文档管理系统，致力于减少前后端沟通成本，提高团队协作开发效率，打造PHP版的RAP。","archived":false,"fork":false,"pushed_at":"2021-08-30T03:00:32.000Z","size":9027,"stargazers_count":119,"open_issues_count":3,"forks_count":36,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-04T04:12:33.554Z","etag":null,"topics":["apidoc","phprap","yii-doc","yii2"],"latest_commit_sha":null,"homepage":"http://www.phprap.com","language":"HTML","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/kuafuRace.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,"roadmap":null,"authors":null}},"created_at":"2018-12-09T05:04:46.000Z","updated_at":"2024-11-11T02:52:42.000Z","dependencies_parsed_at":"2023-06-13T21:09:24.253Z","dependency_job_id":null,"html_url":"https://github.com/kuafuRace/phprap","commit_stats":null,"previous_names":["kuafurace/phprap"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuafuRace%2Fphprap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuafuRace%2Fphprap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuafuRace%2Fphprap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuafuRace%2Fphprap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kuafuRace","download_url":"https://codeload.github.com/kuafuRace/phprap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252116295,"owners_count":21697349,"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":["apidoc","phprap","yii-doc","yii2"],"created_at":"2024-08-03T22:01:20.146Z","updated_at":"2025-05-02T22:31:23.458Z","avatar_url":"https://github.com/kuafuRace.png","language":"HTML","funding_links":[],"categories":["类库"],"sub_categories":["API文档"],"readme":"[PHPRAP，是一个PHP轻量级开源API接口文档管理系统，致力于减少前后端沟通成本，提高团队协作开发效率，打造PHP版的RAP。](http://www.phprap.com)\n\n \u003e版本说明\n - master：稳定版本，建议下载安装，下载[源码](https://gitee.com/gouguoyin/phprap/repository/archive/master.zip)\n - develop：开发版本，功能最新，但不稳定，不建议下载安装 \n \n## 相关\n - 官方网站：[www.phprap.com](http://www.phprap.com)\n - 演示网站：[demo.phprap.com](http://demo.phprap.com)\n - 使用文档：[www.phprap.com/wiki](http://www.phprap.com/wiki/index.html)\n - robeeask社区：[http://phprap.robeeask.com](https://phprap.robeeask.com/)\n \n## 特性\n\n - 基于YII2框架开发，架构合理，性能卓越，具有高度的可重用性和可扩展性；\n - 部署简单，提供在线安装程序，只需填写少量信息即可完成安装部署，开箱即用；\n - 操作简单，和阿里RAP高度一致的操作流程，给力的用户体验，让您一分钟上手；\n - 基于bootstrap搭建，完美适配PC、平板和移动端；\n - 项目申请时时推送，方便项目创建者及时处理申请；\n - 完整的项目操作日志，整个项目的操作流程一目了然；\n - 完善的权限控制系统，可以分别控制成员的项目、环境、模块、接口操作权限；\n - 支持在线对接口进行调试，默认填充已定义好的header和请求参数，再也不用在postman中手动添加参数来调试接口;\n - 提供MOCK服务，根据接口文档自动生成模拟数据，支持复杂的生成逻辑，支持请求协议、请求方式和请求参数格式校验;\n - MOCK数据类型丰富，支持生成随机的文本、数字、布尔值、日期、邮箱、链接、图片、颜色、中文名、手机号、价格、邮箱、网址等;\n - 支持项目整体一键导出HTML文档，方便离线传阅查看；\n - 支持接口单独导出HTML文档，方便离线传阅查看；\n - 产品开源免费，并将持续提供免费的社区技术支持；\n\n## 依赖\n\n - PHP \u003e= 7.0.0\n - MySQL \u003e= 5.1.0\n - PDO 拓展\n - GD 拓展\n - CURL 拓展\n - OPENSSL 拓展\n \n## 安装\n\n- 下载程序到根目录下\n\n  [**GITEE(推荐)**]\n    ```php\n    git clone https://gitee.com/gouguoyin/phprap.git\n    ```\n    \n  [**GITHUB**]\n    ```php\n    git clone https://github.com/gouguoyin/phprap.git\n    ```\n       \n  [**源码**]\n  \n  下载[源码](https://gitee.com/gouguoyin/phprap/repository/archive/master.zip)，解压后将到phprap目录内所有源码上传到根目录下\n    \n- 设置目录权限\n\n    `runtime`目录及子目录给予可读可写权限\n    \n    `configs/db.php`文件给予可读可写权限\n    \n    \n- 隐藏入口文件index.php\n\n  [**IIS**]\n  \n    如果你的服务器环境支持ISAPI_Rewrite的话，可以配置httpd.ini文件，添加下面的内容：\n    \n    \n    ```php\n    RewriteRule (.*)$ /index\\.php\\?r=$1 [I]\n    ```\n   \n    在IIS的高版本下面可以配置web.Config，在中间添加rewrite节点：\n    \n    \n    ```php\n    \u003crewrite\u003e\n    \u003crules\u003e\n    \u003crule name=\"OrgPage\" stopProcessing=\"true\"\u003e\n    \u003cmatch url=\"^(.*)$\" /\u003e\n    \u003cconditions logicalGrouping=\"MatchAll\"\u003e\n    \u003cadd input=\"{HTTP_HOST}\" pattern=\"^(.*)$\" /\u003e\n    \u003cadd input=\"{REQUEST_FILENAME}\" matchType=\"IsFile\" negate=\"true\" /\u003e\n    \u003cadd input=\"{REQUEST_FILENAME}\" matchType=\"IsDirectory\" negate=\"true\" /\u003e\n    \u003c/conditions\u003e\n    \u003caction type=\"Rewrite\" url=\"index.php?r=/{R:1}\" /\u003e\n    \u003c/rule\u003e\n    \u003c/rules\u003e\n    \u003c/rewrite\u003e\n    ```\n   \n  [**Apache**]\n  \n    `httpd.conf`配置文件中加载`mod_rewrite.so`模块\n    \n    将`AllowOverride None` 改为 `AllowOverride All`\n    \n    如果是部署在根目录下，在`.htaccess`中配置转发规则 \n    \n    ```php\n    \u003cIfModule mod_rewrite.c\u003e\n    RewriteEngine on\n   \n    RewriteCond %{REQUEST_FILENAME} !-d\n    RewriteCond %{REQUEST_FILENAME} !-f\n    RewriteRule ^(.*)$ index.php?r=/$1 [QSA,PT,L]\n    \u003c/IfModule\u003e\n    ```\n    \n    如果是部署在二级目录下(假设二级目录是sub_dir)，在`.htaccess`中配置转发规则 \n        \n    ```php\n    \u003cIfModule mod_rewrite.c\u003e\n    RewriteEngine on\n   \n    RewriteCond %{REQUEST_URI} !^/sub_dir/ \n    RewriteCond %{REQUEST_FILENAME} !-d\n    RewriteCond %{REQUEST_FILENAME} !-f\n    RewriteRule ^(.*)$ /sub_dir/index.php?r=/$1 [QSA,PT,L]\n    \u003c/IfModule\u003e\n    ```\n\n  [**Nginx**]\n  \n    如果是部署在根目录下，在`Nginx.conf`中配置转发规则  \n  \n    ```php\n    location / { \n       if (!-e $request_filename) {\n           rewrite  ^(.*)$  /index.php?r=$1  last;\n           break;\n       }\n    }\n    ```\n    \n    如果是部署在二级目录下(假设二级目录是sub_dir)，在Nginx.conf中配置转发规则\n  \n    ```php\n    location /sub_dir/ {\n        if (!-e $request_filename){\n            rewrite  ^/sub_dir/(.*)$  /sub_dir/index.php?r=$1  last;\n        }\n    }\n    ```  \n    \n- 打开浏览器，访问域名，会自动跳转到安装界面运行安装程序\n\n    - 安装步骤一：环境检测\n    ![](http://www.phprap.com/static/images/wiki/install/step1.png?v=1.0)\n    \n    - 安装步骤二：数据库配置\n    ![](http://www.phprap.com/static/images/wiki/install/step2.png?v=1.0)\n\n    - 安装步骤三：管理员配置\n    ![](http://www.phprap.com/static/images/wiki/install/step3.png?v=1.0)\n\n    - 安装步骤四：安装完成\n    ![](http://www.phprap.com/static/images/wiki/install/step4.png?v=1.0)\n\n    \n## 使用\n\n- 用户注册\n\n![](http://www.phprap.com/static/images/wiki/account/register.png?v=1.0)\n\n- 用户登录\n\n![](http://www.phprap.com/static/images/wiki/account/login.png?v=1.0)\n\n- 个人中心\n\n![](http://www.phprap.com/static/images/wiki/account/home.png?v=1.0)\n\n- 修改账号\n\n![](http://www.phprap.com/static/images/wiki/account/update.png?v=1.0)\n\n- 修改密码\n\n![](http://www.phprap.com/static/images/wiki/account/password.png?v=1.0)\n\n- 登录历史\n\n![](http://www.phprap.com/static/images/wiki/account/history.png?v=1.0)\n\n- 项目\n\n    - 新建项目\n    \n    ![](http://www.phprap.com/static/images/wiki/project/create.png?v=1.0)\n    \n    - 编辑项目\n    \n    ![](http://www.phprap.com/static/images/wiki/project/update.png?v=1.0)\n        \n    - 搜索项目\n    \n    ![](http://www.phprap.com/static/images/wiki/project/search.png?v=1.0)\n    \n    - 切换项目\n    \n    ![](http://www.phprap.com/static/images/wiki/project/select.png?v=1.0)\n    \n    - 项目主页\n    \n    ![](http://www.phprap.com/static/images/wiki/project/home.png?v=1.0)\n    \n    - 删除项目\n    \n    ![](http://www.phprap.com/static/images/wiki/project/delete.png?v=1.0)\n    \n    - 导出HTML\n    \n    ![](http://www.phprap.com/static/images/wiki/project/export.png?v=1.0)\n    \n    - 项目动态\n    \n    ![](http://www.phprap.com/static/images/wiki/project/history.png?v=1.0)\n         \n- 模块\n    - 新建模块\n    \n    ![](http://www.phprap.com/static/images/wiki/module/create.png?v=1.0)\n    \n    - 编辑模块\n    \n    ![](http://www.phprap.com/static/images/wiki/module/update.png?v=1.0)\n    \n    - 删除模块\n    \n    ![](http://www.phprap.com/static/images/wiki/module/delete.png?v=1.0)\n    \n- 接口\n\n    - 接口主页\n    \n    ![](http://www.phprap.com/static/images/wiki/api/home.png?v=1.0)\n    \n    - 新建接口\n    \n    ![](http://www.phprap.com/static/images/wiki/api/create.png?v=1.0)\n    \n    - 编辑接口\n    \n    ![](http://www.phprap.com/static/images/wiki/api/update.png?v=1.0)\n    \n    - 删除接口\n    \n    ![](http://www.phprap.com/static/images/wiki/api/delete.png?v=1.0)\n    \n    - 编辑字段\n    \n    ![](http://www.phprap.com/static/images/wiki/field/form.png?v=1.0)\n    \n    - 导入字段\n    \n    ![](http://www.phprap.com/static/images/wiki/field/json.png?v=1.0)\n    \n    - 导出HTML\n    \n    ![](http://www.phprap.com/static/images/wiki/api/export.png?v=1.0)\n    \n- 后台\n\n    - 管理主页\n    \n    ![](http://www.phprap.com/static/images/wiki/manage/home.png?v=1.0)\n\n    - 项目管理\n    \n    ![](http://www.phprap.com/static/images/wiki/manage/project.png?v=1.1)\n    \n    - 回收站管理\n    \n    ![](http://www.phprap.com/static/images/wiki/manage/recycle.png?v=1.0)\n    \n    - 用户管理\n    \n    ![](http://www.phprap.com/static/images/wiki/manage/user.png?v=1.1)\n    \n    - 登录历史\n    \n    ![](http://www.phprap.com/static/images/wiki/manage/history.png?v=1.0)\n    \n    - 系统设置\n    \n    ![](http://www.phprap.com/static/images/wiki/setting/app.png?v=1.0)\n    ![](http://www.phprap.com/static/images/wiki/setting/safe.png?v=1.1)\n    \n## 联系\n\n- 如果您在使用过程中有任何疑问，或有好的意见和想法，请通过以下途径联系我或者新建 [Issue](https://gitee.com/gouguoyin/phprap/issues)  讨论新特性或者变更。\n- 官方网站：[www.phprap.com](http://www.phprap.com)\n- 演示网站：[demo.phprap.com](http://demo.phprap.com)\n- 官方QQ群：421537504 \u003ca style=\"margin-left:10px\" target=\"_blank\" href=\"http://shang.qq.com/wpa/qunwpa?idkey=d49826b55d1759513ce5d68253b3f0589b227587edf87059aa08125e620b73c0\"\u003e\u003cimg border=\"0\" src=\"http://pub.idqqimg.com/wpa/images/group.png\" alt=\"GoPHP官方交流群\" title=\"GoPHP官方交流群\"\u003e\u003c/a\u003e\n\n## 捐献\n- 如果觉得还不错，请作者喝杯咖啡吧，开源不易，您的支持是我前进的动力！\n\n![微信](https://images.gitee.com/uploads/images/2019/1224/114958_fced31b8_544375.jpeg \"wxpay.jpg\")\n![支付宝](https://images.gitee.com/uploads/images/2019/1224/115034_8a947574_544375.jpeg \"alipay.jpg\")\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FkuafuRace%2Fphprap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FkuafuRace%2Fphprap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FkuafuRace%2Fphprap/lists"}