Skip to content

gouguoyin/phprap

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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

版本说明

  • master:稳定版本,建议下载安装,下载源码
  • develop:开发版本,功能最新,但不稳定,不建议下载安装

相关

特性

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

依赖

  • PHP >= 7.0.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目录及子目录给予可读可写权限

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

  • 隐藏入口文件index.php

    [IIS]

    如果你的服务器环境支持ISAPI_Rewrite的话,可以配置httpd.ini文件,添加下面的内容:

    RewriteRule (.*)$ /index\.php\?r=$1 [I]

    在IIS的高版本下面可以配置web.Config,在中间添加rewrite节点:

    <rewrite>
    <rules>
    <rule name="OrgPage" stopProcessing="true">
    <match url="^(.*)$" />
    <conditions logicalGrouping="MatchAll">
    <add input="{HTTP_HOST}" pattern="^(.*)$" />
    <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
    <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
    </conditions>
    <action type="Rewrite" url="index.php?r=/{R:1}" />
    </rule>
    </rules>
    </rewrite>

    [Apache]

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

    AllowOverride None 改为 AllowOverride All

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

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

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

    <IfModule mod_rewrite.c>
    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]
    </IfModule>

    [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;
        }
    }
  • 打开浏览器,访问域名,会自动跳转到安装界面运行安装程序

    • 安装步骤一:环境检测

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

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

    • 安装步骤四:安装完成

使用

  • 用户注册

  • 用户登录

  • 个人中心

  • 修改账号

  • 修改密码

  • 登录历史

  • 项目

    • 新建项目

    • 编辑项目

    • 搜索项目

    • 切换项目

    • 项目主页

    • 删除项目

    • 导出HTML

    • 项目动态

  • 模块

    • 新建模块

    • 编辑模块

    • 删除模块

  • 接口

    • 接口主页

    • 新建接口

    • 编辑接口

    • 删除接口

    • 编辑字段

    • 导入字段

    • 导出HTML

  • 后台

    • 管理主页

    • 项目管理

    • 回收站管理

    • 用户管理

    • 登录历史

    • 系统设置

联系

  • 如果您在使用过程中有任何疑问,或有好的意见和想法,请通过以下途径联系我或者新建 Issue 讨论新特性或者变更。
  • 官方网站:www.phprap.com
  • 演示网站:demo.phprap.com
  • 官方QQ群:421537504 GoPHP官方交流群

捐献

  • 如果觉得还不错,请作者喝杯咖啡吧,开源不易,您的支持是我前进的动力!

微信 支付宝

About

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

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published