安装大概只须要几分钟,可以安装在Windows做事器、Mac、Linux做事器、虚拟机、Docker等,可以利用宝塔、IIS、Nginx、Apache等软件。上传到做事器,解压并配置好域名后。访问首页,可以看到并点击进入【首次利用,请先安装】。
随后进入安装引导界面。
填写数据库账号密码,以及管理员的账号密码,然后开始安装。

安装成功后,就可以开始进行二次开拓。
系统项目和源代码构造接口大师的系统项目紧张分为5个子系统:平台展示官网、管理后台、开放平台、OpenAPI及在线接口文档、技能开拓文档。
个中,源代码分为:PHP源代码一套、两套前端Vue/Javascript源代码、还有PHPUnit单元测试源代码。
如果是开拓API接口,可以利用PHP编程措辞进行开拓(请放心,对付未利用PHP的技能职员,PHP是一门能快速上手的编程措辞,并且接口大师已经把API接口的开拓难度降落了近80%以上,同时比自己从零搭建平台可以节省全体项目大概30+天以上的项目周期)。
接口大师基于 PhalApi 开源接口框架,以是它的目录构造和开源版类似。PHP的接口源代码紧张在src目录下。
PhalApi Pro版的目录构造如下,
./├── README.md # 简介├── bin # 脚本目录├── config # 配置目录│ ├── app.php # 运用配置│ ├── dbs.php # 数据库配置│ ├── di.php # 依赖做事配置│ └── sys.php #系统配置├── data # 数据库│ └── phalapi_pro.sql # 数据库安装时的文件├── language # 翻译包├── pro_admin # 管理后台的前端源代码,基于iview-admin├── pro_platform # 开放平台的前端源代码,基于iview-admin├── public # 对外访问的目录│ ├── admin # 管理后台访问入口(相称于pro_admin打包构建后的dist目录)│ ├── api # 接口访问入口(内分前台API和后台API)│ ├── docs # 离线天生的HTML接口文档│ ├── docs.php # 在线版接口文档访问入口│ ├── index.php│ ├── init.php # 全局初始化文件│ ├── install # 安装引导(成功安装后建议删除此目录)│ ├── platform # 开放平台访问入口(相称于pro_platform打包构建后的dist目录)│ ├── static # 静态资源│ ├── uploads # 上传目录(须要有写入权限)│ └── wiki # 技能文档├── runtime # 运行目录│ ├── _install.lock # 安装锁定文件│ ├── cache # 文件缓存│ └── log # 文件日志├── sdk # SDK包├── src # 项目源代码,非常主要│ ├── admin # 后台接口源代码(遵照ADM模式)│ ├── app # 开放平台接口源代码(遵照ADM模式)│ ├── base # 根本包源代码(放置底层公共的代码,不对外直接供应接口,即不供应Api层)│ ├── platform # 开放平台接口源代码(遵照ADM模式)│ ├── task # 操持任务接口源代码(遵照ADM模式)│ └── view # 页面模板目录(如接口文档)├── tests # 单元测试└── vendor # composer包,不须要手动修正,通过composer install/update可进行安装和更新
接口划分如下:
个中,App开放接口,这部分便是你给你的客户供应的接口,用来放置你的api数据做事接口。末了实时更新的在线接口文档(自动天生,不须要开拓者人工掩护),类似如下:
连接你的数据库
大概熟习系统的源代码和代码目录构造后,我们还须要做一个准备事情,便是连接你原来的数据库,即将要开放数据做事的数据库。
目前,接口大师支持MySQL、MS SQL、PostgreSQL、Oracle 等数据库。
为此,你须要修正数据库配置文件./config/db_plus.php,修正里面的数据库连接配置。例如:
'servers' => array( 'db_master' => array( // 做事器标记 'type' => 'mysql', // TODO: 数据库类型,暂时只支持:mysql, sqlserver 'host' => '127.0.0.1', // TODO: 数据库域名 'name' => 'phalapi_pro', // TODO: 数据库名字 'user' => 'root', // TODO: 数据库用户名 'password' => '', // TODO: 数据库密码 'port' => 3306, // 数据库端口 'charset' => 'utf8mb4', // 数据库字符集 utf8mb4或utf8 'pdo_attr_string' => false, // 数据库查询结果统一利用字符串,true是,false否 'driver_options' => array( // PDO初始化时的连接选项配置 // 若须要更多配置,请参考官方文档:https://www.php.net/manual/zh/pdo.constants.php ), ), ),
你也可以利用.env 文件进行环境变量的配置,再更换到上面的数据库配置文件。
修正DI注册文件./config/di.php,去掉以下代码的注释,注册并开启$di->notorm_plus做事。
// 连接其他数据库(或项目原有的数据库,须要时去掉注释)// $di->notorm_plus = new NotORMDatabase($di->config->get('dbs_plus'), $di->config->get('sys.notorm_debug'));
在完成前面配置后,末了一步,便可以开始开拓你的业务逻辑,连接或操作其他数据库。此时,新加的Model子类,如果是操作新增的数据库,则须要继续于Base\Model\PlusBase基类。例如:
<?phpnamespace App\Model\Plus;use Base\Model\PlusBase;class Comment extends PlusBase { // 实现详细的数据库操作}
这样,就可以连接和利用你的数据库表,进行API接口的开拓和测试了。
开拓并上架你的数据API接口大师的一大开拓特色,便是可以通过管理后台的界面,进行API低代码的在线开拓。
先登录管理后台:
进入管理后台-接口管理-可视化接口设计-添加接口。
比如开放一个根据植物名称查询植物档案的接口,可以依次填写表单,把接口的标题、功能、须要的接口参数、接口返回字段、接口要求示例等写上。接口设计类型可以选择:普通接口API。然后【天生代码】。确认没问题后,可以【保存并发布】。发布后仍旧可以连续修正和开拓。
发布接口后,你就会看到类似以下的在线接口文档。具备在线接口测试等功能。非常方便。
设置API数据套餐和用度
有了业务数据,也有了API接口,下一步便是为我们供应的API数据接口设置用度和套餐。
进入管理后台-做事大厅-接口流量套餐-添加套餐。
类型选择:付费购买。
套餐名称:可以自己填写。
接口做事:选择刚才开拓新增的API接口。
接口流量、套餐价格、有效韶光:自己进行资费的配置。
配置套餐成功后,可以在后台看到套餐列表。
开拓者在线购买和利用
当API接口配置套餐后,下一步,你的客户就可以在前台进行查看和购买。
对付须要付费才能利用的接口,接口列表会有【付费】标签提示。
进入到在线接口文档详情页,可以看到详细的接口流量套餐。
点击套餐,可以进行在线购买。支持支付宝等多种支付办法。
开拓者购买后,可以在开放平台-做事大厅-我的套餐,查看我购买的套餐和流量花费情形。
也可以在开放平台看到其他的统计数据,例如流量统计等。
后台流量统计和账单管理
末了,回到管理后台,可以看到全服的接口流量统计,每个运用、每个客户不同的统计数据。
也可以在后台看到订单、套餐和账单等数据。
当然,你也可以配置支付宝等在线支付的办法,不须要额外的开拓。
还可以管理客户账号:
分配和管理接口权限:
基本上若搭建一个api数据交易平台,你只须要开拓核心的API接口业务逻辑,剩下的接口大师都已经自动帮你完成,包括但不限于:自动天生接口文档(还支持离线文档导出)、接口权限管理、接口套餐管理、接口流量统计、接口日记、接口安全等。同时,可以节省30天+以上的项目周期,可以快速上线,为你的客户供应api数据做事。