resthinkphp / phprap

PHPRAP是一个PHP轻量级开源API接口文档管理系统，致力于提高前后端协作开发效率，打造PHP版的RAP。

PHPRAP，是一个PHP轻量级开源API接口文档管理系统，致力于提高前后端协作开发效率，打造PHP版的RAP

特性

• 部署简单，提供在线安装程序，只需填写少量信息即可完成安装部署；
• 操作简单，和阿里RAP高度一致的操作流程，给力的用户体验，让你一分钟上手；
• 基于bootstrap搭建，完美适配PC和移动端；
• 支持在线对API进行测试并保存测试数据，提高接口测试效率；
• 项目申请时时推送，方便项目创建者及时处理申请，申请加入者及时获取审核结果；
• 完整的项目操作日志，整个项目的操作流程一目了然；
• 完善的权限控制系统，可以分别控制项目、模块、接口和成员的操作权限；
• 支持项目接口一键导出，方便离线查看；
• 产品开源免费，并将持续提供免费的社区技术支持；

依赖

• PHP >= 5.5.0
• PDO 拓展
• GD 拓展
• CURL 拓展
• MCRYPT 拓展

安装

• 下载程序

  [GITHUB]

  git clone https://github.com/gouguoyin/phprap.git

  [GITEE]

  git clone https://gitee.com/gouguoyin/phprap.git

  [源码]

  下载源码，上传到服务器上后解压

• 绑定域名

  将域名绑定到`public`目录上

• 设置目录权限

  runtime目录及子目录给予可读可写权限

• 开启UrlRewrite隐藏入口文件index.php

  [Apache]

  httpd.conf配置文件中加载mod_rewrite.so模块

  将AllowOverride None 改为 AllowOverride All

  把下面的内容保存为.htaccess文件放到应用入口文件的同级目录下，默认放在public目录下

  <IfModule mod_rewrite.c>
  RewriteEngine on
  RewriteCond %{REQUEST_FILENAME} !-d
  RewriteCond %{REQUEST_FILENAME} !-f
  RewriteRule ^(.*)$ index.php?r=/$1 [QSA,PT,L]
  </IfModule>

  [Nginx]

  如果是部署在根目录下，在Nginx.conf中配置转发规则

  location / { 
     if (!-e $request_filename) {
         rewrite  ^(.*)$  /index.php?r=$1  last;
         break;
     }
  }

  如果是部署在二级目录下，在Nginx.conf中配置转发规则

  location /SUB_DIR/ {
      if (!-e $request_filename){
          rewrite  ^/SUB_DIR/(.*)$  /sub_dir/index.php?r=$1  last;
      }
  }

  SUB_DIR换成自己的目录

• 打开浏览器,访问安装向导http://你的域名/install

  • 安装步骤一：环境检测

  • 安装步骤二：数据库配置

  • 安装步骤三：管理员配置

  • 安装步骤四：安装完成

使用

• 注册

• 登录

• 修改资料

• 消息通知

• 登录历史

• 项目

  • 新建项目

  • 编辑项目

  • 转让项目

  • 搜索项目

  • 切换项目

  • 项目主页

  • 项目成员

  • 成员权限

  • 项目动态

  • 删除项目

• 模块

  • 新建模块

  • 编辑模块

  • 删除模块

• 接口

  • 添加接口

  • 编辑接口

  • 接口主页

  • 删除接口

  • 添加字段

  • 编辑字段

  • 删除字段

• 后台

  • 管理主页

  • 项目管理

  • 用户管理

  • 登录历史

  • 数据备份

  • 系统设置

TODO

• 多版本支持及版本权限控制;
• 项目复制及复制权限控制;
• RAP、POSTMAN数据导入；
• 支持对API修改历史版本进行对比，版本回溯等操作；
• 支持接口签名，sign逻辑；
• 通过建表语句导入数据字典；
• 支持在线对API进行测试并保存测试数据；

联系

• 如果您在使用过程中有任何疑问，或有好的意见和想法，请通过以下途径联系我或者新建 Issue 讨论新特性或者变更。
• 官方网站：phprap.gouguoyin.cn
• 演示网站：apidoc.gouguoyin.cn
• 作者博客：www.gouguoyin.cn
• 官方QQ群：421537504