轻量级 API 接口文档管理系统 PHPRAP

Apache
PHP JavaScript
跨平台
2017-10-28
够过瘾

PHPRAP,是一个PHP轻量级开源API接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造PHP版的RAP。它:

  • 基于YII2框架开发,架构合理,性能卓越,具有高度的可重用性和可扩展性;
  • 部署简单,提供在线安装程序,只需填写少量信息即可完成安装部署,开箱即用;
  • 操作简单,和阿里RAP高度一致的操作流程,给力的用户体验,让您一分钟上手;
  • 基于bootstrap搭建,完美适配PC、平板和移动端;
  • 加入项目申请时时推送,方便项目创建者及时处理申请;
  • 完整的项目操作日志,整个项目的操作流程一目了然;
  • 完善的权限控制系统,可以分别控制项目、环境、模块、接口和成员的操作权限;
  • 支持在线对接口进行调试,默认填充已定义好的header和请求参数,再也不用在postman中手动添加参数来调试接口;
  • 提供MOCK服务,根据接口文档自动生成模拟数据,支持复杂的生成逻辑,支持请求协议、请求方式和请求参数合法性校验;
  • MOCK数据类型丰富,支持生成随机的文本、数字、布尔值、日期、邮箱、链接、图片、颜色、中文名、手机号、价格、邮箱、网址等;
  • 支持项目整体一键导出HTML文档,方便离线查看;
  • 支持接口单独一键导出HTML文档,方便离线查看;
  • 产品开源免费,并将持续提供免费的社区技术支持;

相关

依赖

  • PHP >= 5.6.0
  • MySQL >= 5.1.0
  • PDO 拓展
  • GD 拓展
  • CURL 拓展
  • OPENSSL 拓展

安装

  • 下载程序

    [GITEE](推荐)

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

    [GITHUB]

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

    [源码]

    下载源码,解压后将到phprap目录内所有源码上传到根目录下

  • 设置目录权限

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

    config/db.php文件给予可读可写权限

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

    [Apache]

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

    AllowOverride None 改为 AllowOverride All

    如果是部署在根目录下,在.htaccess中配置转发规则

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

    如果是部署在二级目录下(假设二级目录是sub_dir),在.htaccess中配置转发规则

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

    [Nginx]

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

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

    如果是部署在二级目录下(假设二级目录是sub_dir),在Nginx.conf中配置转发规则

    location /sub_dir/ {
        if (!-e $request_filename){
            rewrite  ^/sub_dir/(.*)$  /sub_dir/index.php?r=$1  last;
        }
    }
    
  • 打开浏览器,访问域名,会自动跳转到安装界面运行安装程序

    • 安装步骤一:环境检测 

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

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

    • 安装步骤四:安装完成 

使用

  • 用户注册 

  • 用户登录 

  • 个人主页 

  • 修改资料 

  • 修改密码 

  • 登录历史 

  • 项目

    • 项目主页 

    • 新建项目 

    • 编辑项目 

    • 转让项目 

    • 搜索项目 

    • 切换项目 

    • 导出文档 

    • 删除项目 

    • 项目动态 

  • 模块

    • 新建模块 

    • 编辑模块 

    • 删除模块 

  • 接口

    • 接口主页 

    • 添加接口 

    • 编辑接口 

    • 删除接口 

    • 编辑字段 

    • 导入字段 

    • 导出文档 

  • 后台

    • 管理主页 

    • 项目管理 

    • 用户管理 

    • 登录历史 

    • 系统设置 

的码云指数为
超过 的项目
加载中

评论(18)

jxq
jxq
很不错,已经在用,请问接口测试 入口在哪里呢?
够过瘾
够过瘾 软件作者
加QQ群421537504
TonightBar
TonightBar
clone 了两次码云的代码,部署到了两个站点,安装成功,但是无法创建项目,添加项目那里,点击确认无反应,两个站点都是这样,环境基本上一样,Centos7 php7.3 mysql5.7,可能是哪里原因?
够过瘾
够过瘾 软件作者
加QQ群421537504报错截图发下
TonightBar
TonightBar
刚刚删除了2.0.1版本,安装了最新的2.0.2版本,就好了
qq1094080047
qq1094080047
php 7.0无法使用 连接不到数据库
够过瘾
够过瘾 软件作者
已修复
剑客落落
剑客落落
我自己开发的文档系统,是通过读取代码中的注释来生成,这样写代码的时候写好注释就可以一键生成文档,代码的可读性也好多了,更重要的是能强制团队成员养成写注释的习惯,一举多得
够过瘾
够过瘾 软件作者
需求不同,你说的这些apidoc和swagger都可以实现
番茄蛋饭
番茄蛋饭
看着不错,试试用一次
追风K
追风K
好用
Blake_
Blake_
为什么我安装时候 出现一直刷新页面的问题
够过瘾
够过瘾 软件作者
已修复
开水烫猪皮
用了一个月了,很好
锟铻科技
锟铻科技
嘿嘿~~忘点星了~
王湘江
团队内部使用中,很好用,力荐。
够过瘾
够过瘾 软件作者
感谢使用

PHPRAP 2.0.4 发布,新增字段模板功能

PHPRAP,是一个基于 YII2 框架开发的 PHP 轻量级开源 API 接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造 PHP 版的 RAP。 更新记录 【新增】新增项目字段模板功能...

09/24 10:29

PHPRAP 2.0.3 发布,新增在线调试功能

PHPRAP,是一个基于 YII2 框架开发的 PHP 轻量级开源 API 接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造 PHP 版的 RAP。 更新记录 【新增】新增在线调试功能,不...

09/18 15:18

PHPRAP 2.0.2 发布,接口和字段数据分离,字段使用单独数据表

PHPRAP,是一个基于 YII2 框架开发的 PHP 轻量级开源 API 接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造 PHP 版的 RAP。 更新记录 【新增】添加接口时新增 xml ...

09/02 09:56

PHPRAP 2.0.1 发布,界面优化和新增项目动态功能

PHPRAP,是一个PHP轻量级开源API接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造PHP版的RAP。如果您觉得PHPRAP对您有用的话,别忘了给点个赞哦^_^ ! 官方网站 ww...

08/20 12:10

PHPRAP 2.0.0 发布,历时一年最大更新版本,底层架构重构

PHPRAP,是一个PHP轻量级开源API接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造PHP版的RAP。如果您觉得PHPRAP对您有用的话,别忘了给点个赞哦^_^ ! 官方网站 ww...

08/16 15:34

PHPRAP v1.0.8 版本发布,安装时数据库不存在自动创建

PHPRAP,是一个 PHP 轻量级开源 API 接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造 PHP 版的 RAP 。 PHPRAP已被GVP(码云最有价值开源项目计划)收录 更新记录 【修...

2017/12/13 13:52

PHPRAP v1.0.7 版本发布,新增数据字典功能

PHPRAP,是一个 PHP 轻量级开源 API 接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造 PHP 版的 RAP 。 更新记录 【修复】修复在PHP7.1及之上版本部分页面报错的BUG...

2017/12/01 10:11

PHPRAP 启用独立域名 www.phprap.com

PHPRAP,是一个PHP轻量级开源API接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造PHP版的RAP。 更新记录 【优化】启用独立域名 http://www.phprap.com 【修复】修复...

2017/11/27 16:43

PHPRAP v1.0.6 版本发布,修复 BUG

PHPRAP,是一个PHP轻量级开源API接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造PHP版的RAP。 更新记录 【修复】修复在特殊情况下安装界面不断刷新的BUG 修复】mcr...

2017/11/23 16:47

PHPRAP v1.0.5 版本发布,注册页面增加注册口令项

PHPRAP,是一个PHP轻量级开源API接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造PHP版的RAP。 更新记录 【修复】修复PHP7.1下报db()函数缺少默认参数的BUG 【修复】...

2017/11/21 10:00

没有更多内容

加载失败,请刷新页面

暂无问答

PHPRAP 1.0.0 发布,打造 PHP 版 API 接口管理系统

PHPRAP,是一个PHP轻量级开源API接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造PHP版的RAP。 特性 部署简单,提供在线安装程序,只需填写少量信息即可完成安装部署...

2018/07/06 16:28
28
0
PHPRAP 2.0.2 发布,接口和字段数据分离,字段使用单独数据表

PHPRAP,是一个基于YII2框架开发的PHP轻量级开源API接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造PHP版的RAP。如果您觉得PHPRAP对您有用的话,别忘了给点个赞哦^...

09/02 10:26
7
0
PHPRAP 2.0.1 发布,界面优化和新增项目动态功能

PHPRAP,是一个基于Y2框架开发的PHP轻量级开源API接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造PHP版的RAP。如果您觉得PHPRAP对您有用的话,别忘了给点个赞哦^_^...

08/21 13:36
30
0
PHPRAP 2.0.0 发布,历时一年最大更新版本,底层架构重构

PHPRAP,是一个PHP轻量级开源API接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造PHP版的RAP。如果您觉得PHPRAP对您有用的话,别忘了给点个赞哦^_^ ! 官方网站 ww...

08/16 16:02
22
0
PHPRAP 1.0.1 发布,修复 Bug 并支持 MOCK 服务

PHPRAP,是一个PHP轻量级开源API接口文档管理系统,致力于减少前后端沟通成本,提高团队协作开发效率,打造PHP版的RAP。 更新记录 修复在nginx服务器下报错的BUG 修复PHP7版无法获取mysql版本...

2017/11/05 09:23
88
0
收藏了8年的PHP优秀资源,都给你整理好了

以下是我整理好的 PHP 资源,各位看官拿去用,不用再自己找了。 每周在 GitHub 上更新,觉得不错请点个 Star ❤️ 如转载分享,请保留出处,谢谢 😆 原文地址: https://shockerli.net/pos...

01/30 19:32
363
2

没有更多内容

加载失败,请刷新页面

没有更多内容

返回顶部
顶部